{ "item": [ { "name": "mandates", "description": "", "item": [ { "id": "35a7f6a1-8324-4029-b31a-1dd881488ab3", "name": "Create a new mandate", "request": { "name": "Create a new mandate", "description": { "content": "Creates a new delegation mandate between a principal and a delegate.\nThe mandate defines the scope of delegated authority, optional constraints,\nand an expiration date. A KMS-signed audit event is emitted on success.\n", "type": "text/plain" }, "url": { "path": [ "mandates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"principal\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"delegate\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"scope\": {\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"effect\": \"ALLOW\",\n \"conditions\": {}\n },\n \"constraints\": {\n \"max_uses\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"time\": {\n \"not_before\": \"\",\n \"expires_at\": \"\"\n },\n \"geo_fence\": {\n \"allowed_regions\": [\n \"\",\n \"\"\n ]\n },\n \"require_mfa\": \"\",\n \"ip_whitelist\": [\n \"\",\n \"\"\n ],\n \"transaction_limits\": {\n \"max_amount\": {\n \"currency\": \"LJK\",\n \"value\": \"4178664\"\n },\n \"max_total\": [\n {\n \"amount\": {\n \"currency\": \"CHC\",\n \"value\": \"0\"\n },\n \"window\": \"P1D\"\n },\n {\n \"amount\": {\n \"currency\": \"NKE\",\n \"value\": \"59647497.2970\"\n },\n \"window\": \"P1D\"\n }\n ],\n \"key_0\": 5070,\n \"key_1\": 75,\n \"key_2\": true\n },\n \"rate_limits\": {\n \"max_count\": [\n {\n \"count\": \"\",\n \"window\": \"P1W\"\n },\n {\n \"count\": \"\",\n \"window\": \"P1D\"\n }\n ],\n \"key_0\": true,\n \"key_1\": false\n },\n \"escalation_rules\": {\n \"deviation_above_percent\": \"\",\n \"amount_above\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"escalate_to\": \"\",\n \"escalation_method\": \"\"\n }\n },\n \"metadata\": {},\n \"expires_at\": \"\",\n \"taxonomy_id\": \"\",\n \"taxonomy_version\": \"zh8w@2167688559.9.6633863685-b\",\n \"require_approval\": false,\n \"intent\": {\n \"purpose\": \"\",\n \"expected_clusters\": [\n \"\",\n \"\"\n ],\n \"drift_threshold\": 0.7\n },\n \"vui\": {\n \"instruction_text\": \"\",\n \"instruction_channel\": \"voice\",\n \"principal_confirmation\": {\n \"method\": \"explicit_approval\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"constraints_derived\": {\n \"max_amount\": \"\",\n \"allowed_actions\": [\n \"\",\n \"\"\n ],\n \"time_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fb796d8d-e25d-4bff-84ef-4387a2c046a2", "name": "Mandate created.\n\nWhen the request carried constraint keys that no code path\nevaluates, the response also names them in\n`unsupported_constraints`. The mandate is created either way — the\nkeys are stored, they simply do not restrict anything. Treat a\nnon-empty `unsupported_constraints` as a bug in your mandate.", "originalRequest": { "url": { "path": [ "mandates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"principal\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"delegate\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"scope\": {\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"effect\": \"ALLOW\",\n \"conditions\": {}\n },\n \"constraints\": {\n \"max_uses\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"time\": {\n \"not_before\": \"\",\n \"expires_at\": \"\"\n },\n \"geo_fence\": {\n \"allowed_regions\": [\n \"\",\n \"\"\n ]\n },\n \"require_mfa\": \"\",\n \"ip_whitelist\": [\n \"\",\n \"\"\n ],\n \"transaction_limits\": {\n \"max_amount\": {\n \"currency\": \"LJK\",\n \"value\": \"4178664\"\n },\n \"max_total\": [\n {\n \"amount\": {\n \"currency\": \"CHC\",\n \"value\": \"0\"\n },\n \"window\": \"P1D\"\n },\n {\n \"amount\": {\n \"currency\": \"NKE\",\n \"value\": \"59647497.2970\"\n },\n \"window\": \"P1D\"\n }\n ],\n \"key_0\": 5070,\n \"key_1\": 75,\n \"key_2\": true\n },\n \"rate_limits\": {\n \"max_count\": [\n {\n \"count\": \"\",\n \"window\": \"P1W\"\n },\n {\n \"count\": \"\",\n \"window\": \"P1D\"\n }\n ],\n \"key_0\": true,\n \"key_1\": false\n },\n \"escalation_rules\": {\n \"deviation_above_percent\": \"\",\n \"amount_above\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"escalate_to\": \"\",\n \"escalation_method\": \"\"\n }\n },\n \"metadata\": {},\n \"expires_at\": \"\",\n \"taxonomy_id\": \"\",\n \"taxonomy_version\": \"zh8w@2167688559.9.6633863685-b\",\n \"require_approval\": false,\n \"intent\": {\n \"purpose\": \"\",\n \"expected_clusters\": [\n \"\",\n \"\"\n ],\n \"drift_threshold\": 0.7\n },\n \"vui\": {\n \"instruction_text\": \"\",\n \"instruction_channel\": \"voice\",\n \"principal_confirmation\": {\n \"method\": \"explicit_approval\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"constraints_derived\": {\n \"max_amount\": \"\",\n \"allowed_actions\": [\n \"\",\n \"\"\n ],\n \"time_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mandate_id\": \"\",\n \"tenant_id\": \"\",\n \"version\": \"\",\n \"status\": \"SUSPENDED\",\n \"principal\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"delegate\": {\n \"type\": \"AI_AGENT\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"scope\": {\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"effect\": \"ALLOW\",\n \"conditions\": {}\n },\n \"constraints\": {\n \"max_uses\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"time\": {\n \"not_before\": \"\",\n \"expires_at\": \"\"\n },\n \"geo_fence\": {\n \"allowed_regions\": [\n \"\",\n \"\"\n ]\n },\n \"require_mfa\": \"\",\n \"ip_whitelist\": [\n \"\",\n \"\"\n ],\n \"transaction_limits\": {\n \"max_amount\": {\n \"currency\": \"JJR\",\n \"value\": \"5\"\n },\n \"max_total\": [\n {\n \"amount\": {\n \"currency\": \"SWF\",\n \"value\": \"0.5598391\"\n },\n \"window\": \"PT1H\"\n },\n {\n \"amount\": {\n \"currency\": \"WEW\",\n \"value\": \"6496487268.2\"\n },\n \"window\": \"P1D\"\n }\n ]\n },\n \"rate_limits\": {\n \"max_count\": [\n {\n \"count\": \"\",\n \"window\": \"P1D\"\n },\n {\n \"count\": \"\",\n \"window\": \"P1M\"\n }\n ],\n \"key_0\": \"string\"\n },\n \"escalation_rules\": {\n \"deviation_above_percent\": \"\",\n \"amount_above\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"escalate_to\": \"\",\n \"escalation_method\": \"\"\n }\n },\n \"proof\": {\n \"creation_method\": \"MANUAL\",\n \"issuer\": \"\",\n \"created_by\": \"\",\n \"created_by_type\": \"SERVICE\",\n \"created_by_auth_method\": \"\",\n \"mandate_hash\": \"\",\n \"signature\": \"\",\n \"eidas_loa\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\",\n \"vui\": {\n \"instruction_text\": \"\",\n \"instruction_hash\": \"\",\n \"instruction_timestamp\": \"\",\n \"instruction_channel\": \"voice\",\n \"principal_confirmation\": {\n \"method\": \"explicit_approval\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"constraints_derived\": {\n \"max_amount\": \"\",\n \"allowed_actions\": [\n \"\",\n \"\"\n ],\n \"time_bound\": \"\"\n }\n },\n \"approval\": {\n \"approved_by\": \"\",\n \"approved_by_type\": \"SERVICE\",\n \"approved_by_auth_method\": \"\",\n \"approved_at\": \"\"\n },\n \"unsupported_constraints\": [\n \"\",\n \"\"\n ],\n \"unsupported_constraints_message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f44ed953-d393-4e13-b64b-a974edd9d411", "name": "Invalid request", "originalRequest": { "url": { "path": [ "mandates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"principal\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"delegate\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"scope\": {\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"effect\": \"ALLOW\",\n \"conditions\": {}\n },\n \"constraints\": {\n \"max_uses\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"time\": {\n \"not_before\": \"\",\n \"expires_at\": \"\"\n },\n \"geo_fence\": {\n \"allowed_regions\": [\n \"\",\n \"\"\n ]\n },\n \"require_mfa\": \"\",\n \"ip_whitelist\": [\n \"\",\n \"\"\n ],\n \"transaction_limits\": {\n \"max_amount\": {\n \"currency\": \"LJK\",\n \"value\": \"4178664\"\n },\n \"max_total\": [\n {\n \"amount\": {\n \"currency\": \"CHC\",\n \"value\": \"0\"\n },\n \"window\": \"P1D\"\n },\n {\n \"amount\": {\n \"currency\": \"NKE\",\n \"value\": \"59647497.2970\"\n },\n \"window\": \"P1D\"\n }\n ],\n \"key_0\": 5070,\n \"key_1\": 75,\n \"key_2\": true\n },\n \"rate_limits\": {\n \"max_count\": [\n {\n \"count\": \"\",\n \"window\": \"P1W\"\n },\n {\n \"count\": \"\",\n \"window\": \"P1D\"\n }\n ],\n \"key_0\": true,\n \"key_1\": false\n },\n \"escalation_rules\": {\n \"deviation_above_percent\": \"\",\n \"amount_above\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"escalate_to\": \"\",\n \"escalation_method\": \"\"\n }\n },\n \"metadata\": {},\n \"expires_at\": \"\",\n \"taxonomy_id\": \"\",\n \"taxonomy_version\": \"zh8w@2167688559.9.6633863685-b\",\n \"require_approval\": false,\n \"intent\": {\n \"purpose\": \"\",\n \"expected_clusters\": [\n \"\",\n \"\"\n ],\n \"drift_threshold\": 0.7\n },\n \"vui\": {\n \"instruction_text\": \"\",\n \"instruction_channel\": \"voice\",\n \"principal_confirmation\": {\n \"method\": \"explicit_approval\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"constraints_derived\": {\n \"max_amount\": \"\",\n \"allowed_actions\": [\n \"\",\n \"\"\n ],\n \"time_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee98a448-2332-4b4f-a6be-62957d61c8b4", "name": "Authentication required", "originalRequest": { "url": { "path": [ "mandates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"principal\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"delegate\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"scope\": {\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"effect\": \"ALLOW\",\n \"conditions\": {}\n },\n \"constraints\": {\n \"max_uses\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"time\": {\n \"not_before\": \"\",\n \"expires_at\": \"\"\n },\n \"geo_fence\": {\n \"allowed_regions\": [\n \"\",\n \"\"\n ]\n },\n \"require_mfa\": \"\",\n \"ip_whitelist\": [\n \"\",\n \"\"\n ],\n \"transaction_limits\": {\n \"max_amount\": {\n \"currency\": \"LJK\",\n \"value\": \"4178664\"\n },\n \"max_total\": [\n {\n \"amount\": {\n \"currency\": \"CHC\",\n \"value\": \"0\"\n },\n \"window\": \"P1D\"\n },\n {\n \"amount\": {\n \"currency\": \"NKE\",\n \"value\": \"59647497.2970\"\n },\n \"window\": \"P1D\"\n }\n ],\n \"key_0\": 5070,\n \"key_1\": 75,\n \"key_2\": true\n },\n \"rate_limits\": {\n \"max_count\": [\n {\n \"count\": \"\",\n \"window\": \"P1W\"\n },\n {\n \"count\": \"\",\n \"window\": \"P1D\"\n }\n ],\n \"key_0\": true,\n \"key_1\": false\n },\n \"escalation_rules\": {\n \"deviation_above_percent\": \"\",\n \"amount_above\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"escalate_to\": \"\",\n \"escalation_method\": \"\"\n }\n },\n \"metadata\": {},\n \"expires_at\": \"\",\n \"taxonomy_id\": \"\",\n \"taxonomy_version\": \"zh8w@2167688559.9.6633863685-b\",\n \"require_approval\": false,\n \"intent\": {\n \"purpose\": \"\",\n \"expected_clusters\": [\n \"\",\n \"\"\n ],\n \"drift_threshold\": 0.7\n },\n \"vui\": {\n \"instruction_text\": \"\",\n \"instruction_channel\": \"voice\",\n \"principal_confirmation\": {\n \"method\": \"explicit_approval\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"constraints_derived\": {\n \"max_amount\": \"\",\n \"allowed_actions\": [\n \"\",\n \"\"\n ],\n \"time_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "255b5daf-703f-4e93-8ff8-e885a7f1b1f1", "name": "List mandates (paginated)", "request": { "name": "List mandates (paginated)", "description": { "content": "Returns a paginated list of mandates for the authenticated tenant.\nSupports optional filtering by status and cursor-based pagination.\n", "type": "text/plain" }, "url": { "path": [ "mandates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of DRAFT,ACTIVE,SUSPENDED,REVOKED,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "DRAFT" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0888a04a-f9bb-49f6-8f6c-0fd1d22d2bed", "name": "Paginated list of mandates", "originalRequest": { "url": { "path": [ "mandates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of DRAFT,ACTIVE,SUSPENDED,REVOKED,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "DRAFT" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"mandate_id\": \"\",\n \"tenant_id\": \"\",\n \"version\": \"\",\n \"status\": \"REVOKED\",\n \"principal\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"delegate\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"scope\": {\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"effect\": \"ALLOW\",\n \"conditions\": {}\n },\n \"constraints\": {\n \"max_uses\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"time\": {\n \"not_before\": \"\",\n \"expires_at\": \"\"\n },\n \"geo_fence\": {\n \"allowed_regions\": [\n \"\",\n \"\"\n ]\n },\n \"require_mfa\": \"\",\n \"ip_whitelist\": [\n \"\",\n \"\"\n ],\n \"transaction_limits\": {\n \"max_amount\": {\n \"currency\": \"AFL\",\n \"value\": \"110084761\"\n },\n \"max_total\": [\n {\n \"amount\": {\n \"currency\": \"FAV\",\n \"value\": \"34782912\"\n },\n \"window\": \"P1D\"\n },\n {\n \"amount\": {\n \"currency\": \"OZX\",\n \"value\": \"0.39755\"\n },\n \"window\": \"PT1H\"\n }\n ]\n },\n \"rate_limits\": {\n \"max_count\": [\n {\n \"count\": \"\",\n \"window\": \"P1M\"\n },\n {\n \"count\": \"\",\n \"window\": \"PT1H\"\n }\n ],\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": \"string\",\n \"key_3\": true\n },\n \"escalation_rules\": {\n \"deviation_above_percent\": \"\",\n \"amount_above\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"escalate_to\": \"\",\n \"escalation_method\": \"\"\n }\n },\n \"proof\": {\n \"creation_method\": \"EUDI_WALLET\",\n \"issuer\": \"\",\n \"created_by\": \"\",\n \"created_by_type\": \"NATURAL_PERSON\",\n \"created_by_auth_method\": \"\",\n \"mandate_hash\": \"\",\n \"signature\": \"\",\n \"eidas_loa\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\",\n \"vui\": {\n \"instruction_text\": \"\",\n \"instruction_hash\": \"\",\n \"instruction_timestamp\": \"\",\n \"instruction_channel\": \"voice\",\n \"principal_confirmation\": {\n \"method\": \"explicit_approval\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"constraints_derived\": {\n \"max_amount\": \"\",\n \"allowed_actions\": [\n \"\",\n \"\"\n ],\n \"time_bound\": \"\"\n }\n },\n \"approval\": {\n \"approved_by\": \"\",\n \"approved_by_type\": \"NATURAL_PERSON\",\n \"approved_by_auth_method\": \"\",\n \"approved_at\": \"\"\n }\n },\n {\n \"mandate_id\": \"\",\n \"tenant_id\": \"\",\n \"version\": \"\",\n \"status\": \"DRAFT\",\n \"principal\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"delegate\": {\n \"type\": \"AI_AGENT\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"scope\": {\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"effect\": \"ALLOW\",\n \"conditions\": {}\n },\n \"constraints\": {\n \"max_uses\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"time\": {\n \"not_before\": \"\",\n \"expires_at\": \"\"\n },\n \"geo_fence\": {\n \"allowed_regions\": [\n \"\",\n \"\"\n ]\n },\n \"require_mfa\": \"\",\n \"ip_whitelist\": [\n \"\",\n \"\"\n ],\n \"transaction_limits\": {\n \"max_amount\": {\n \"currency\": \"ZQQ\",\n \"value\": \"877373\"\n },\n \"max_total\": [\n {\n \"amount\": {\n \"currency\": \"JQY\",\n \"value\": \"0\"\n },\n \"window\": \"PT1H\"\n },\n {\n \"amount\": {\n \"currency\": \"KHG\",\n \"value\": \"93129270672929791\"\n },\n \"window\": \"P1D\"\n }\n ]\n },\n \"rate_limits\": {\n \"max_count\": [\n {\n \"count\": \"\",\n \"window\": \"P1D\"\n },\n {\n \"count\": \"\",\n \"window\": \"P1W\"\n }\n ],\n \"key_0\": 5210,\n \"key_1\": 7497\n },\n \"escalation_rules\": {\n \"deviation_above_percent\": \"\",\n \"amount_above\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"escalate_to\": \"\",\n \"escalation_method\": \"\"\n }\n },\n \"proof\": {\n \"creation_method\": \"OAUTH2\",\n \"issuer\": \"\",\n \"created_by\": \"\",\n \"created_by_type\": \"SERVICE\",\n \"created_by_auth_method\": \"\",\n \"mandate_hash\": \"\",\n \"signature\": \"\",\n \"eidas_loa\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\",\n \"vui\": {\n \"instruction_text\": \"\",\n \"instruction_hash\": \"\",\n \"instruction_timestamp\": \"\",\n \"instruction_channel\": \"voice\",\n \"principal_confirmation\": {\n \"method\": \"explicit_approval\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"constraints_derived\": {\n \"max_amount\": \"\",\n \"allowed_actions\": [\n \"\",\n \"\"\n ],\n \"time_bound\": \"\"\n }\n },\n \"approval\": {\n \"approved_by\": \"\",\n \"approved_by_type\": \"NATURAL_PERSON\",\n \"approved_by_auth_method\": \"\",\n \"approved_at\": \"\"\n }\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c97478f-445b-4d0c-99fe-c46b9be48d64", "name": "Authentication required", "originalRequest": { "url": { "path": [ "mandates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of DRAFT,ACTIVE,SUSPENDED,REVOKED,EXPIRED)", "type": "text/plain" }, "key": "status", "value": "DRAFT" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "f3e5b8df-52e7-4a26-abc0-8dec6b7bb3fc", "name": "Get mandate by ID", "request": { "name": "Get mandate by ID", "description": { "content": "Retrieves a single mandate by its ID. Returns the full mandate record\nincluding principal, delegate, scope, constraints, and proof metadata.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "db0b1583-4dda-4bfb-af68-93ccca7edf22", "name": "Mandate details", "originalRequest": { "url": { "path": [ "mandates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mandate_id\": \"\",\n \"tenant_id\": \"\",\n \"version\": \"\",\n \"status\": \"REVOKED\",\n \"principal\": {\n \"type\": \"AI_AGENT\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"delegate\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"scope\": {\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"effect\": \"ALLOW\",\n \"conditions\": {}\n },\n \"constraints\": {\n \"max_uses\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"time\": {\n \"not_before\": \"\",\n \"expires_at\": \"\"\n },\n \"geo_fence\": {\n \"allowed_regions\": [\n \"\",\n \"\"\n ]\n },\n \"require_mfa\": \"\",\n \"ip_whitelist\": [\n \"\",\n \"\"\n ],\n \"transaction_limits\": {\n \"max_amount\": {\n \"currency\": \"TRY\",\n \"value\": \"760580229719168696.60177893335989376\"\n },\n \"max_total\": [\n {\n \"amount\": {\n \"currency\": \"YEC\",\n \"value\": \"0\"\n },\n \"window\": \"P1D\"\n },\n {\n \"amount\": {\n \"currency\": \"COY\",\n \"value\": \"0.49102802\"\n },\n \"window\": \"P1D\"\n }\n ]\n },\n \"rate_limits\": {\n \"max_count\": [\n {\n \"count\": \"\",\n \"window\": \"P1D\"\n },\n {\n \"count\": \"\",\n \"window\": \"PT1H\"\n }\n ]\n },\n \"escalation_rules\": {\n \"deviation_above_percent\": \"\",\n \"amount_above\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"escalate_to\": \"\",\n \"escalation_method\": \"\"\n }\n },\n \"proof\": {\n \"creation_method\": \"OAUTH2\",\n \"issuer\": \"\",\n \"created_by\": \"\",\n \"created_by_type\": \"SERVICE\",\n \"created_by_auth_method\": \"\",\n \"mandate_hash\": \"\",\n \"signature\": \"\",\n \"eidas_loa\": \"\"\n },\n \"metadata\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\",\n \"vui\": {\n \"instruction_text\": \"\",\n \"instruction_hash\": \"\",\n \"instruction_timestamp\": \"\",\n \"instruction_channel\": \"email\",\n \"principal_confirmation\": {\n \"method\": \"explicit_approval\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"constraints_derived\": {\n \"max_amount\": \"\",\n \"allowed_actions\": [\n \"\",\n \"\"\n ],\n \"time_bound\": \"\"\n }\n },\n \"approval\": {\n \"approved_by\": \"\",\n \"approved_by_type\": \"SERVICE\",\n \"approved_by_auth_method\": \"\",\n \"approved_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1885e59e-d371-4419-8b02-e926e0fbc8d7", "name": "Resource not found", "originalRequest": { "url": { "path": [ "mandates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "revoke", "description": "", "item": [ { "id": "3bc0f549-1216-413c-ab46-c021eefe97fc", "name": "Revoke a mandate", "request": { "name": "Revoke a mandate", "description": { "content": "Permanently revokes a mandate. Only active or suspended mandates can be\nrevoked. An optional reason can be provided. A KMS-signed audit event is emitted.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b2383d71-d049-43f9-9b12-98019e9c6ac3", "name": "Mandate revoked", "originalRequest": { "url": { "path": [ "mandates", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mandate_id\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd43ab2-a008-4de2-a76e-141b5bf39d82", "name": "State conflict", "originalRequest": { "url": { "path": [ "mandates", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "suspend", "description": "", "item": [ { "id": "51e3e0cd-c475-4a78-9357-a3eda854aa09", "name": "Suspend a mandate", "request": { "name": "Suspend a mandate", "description": { "content": "Temporarily suspends an active mandate. Suspended mandates can be\nreactivated later. An optional reason can be provided.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "27a6c193-a4a7-4096-9762-f739cd9c9b5f", "name": "Mandate suspended", "originalRequest": { "url": { "path": [ "mandates", ":id", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mandate_id\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "725a2b51-a255-4338-a766-e97b72de366c", "name": "State conflict", "originalRequest": { "url": { "path": [ "mandates", ":id", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reactivate", "description": "", "item": [ { "id": "4428e55e-8735-4780-bcf6-d3691455a1a0", "name": "Reactivate a suspended mandate", "request": { "name": "Reactivate a suspended mandate", "description": { "content": "Reactivates a previously suspended mandate, returning it to ACTIVE status.\nOnly mandates in SUSPENDED state can be reactivated.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d0b3b733-42ca-45d5-8cf1-ded1f90a9d12", "name": "Mandate reactivated", "originalRequest": { "url": { "path": [ "mandates", ":id", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mandate_id\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3af9453b-9a73-4d8d-9767-dc9cb91ea597", "name": "State conflict", "originalRequest": { "url": { "path": [ "mandates", ":id", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "approve", "description": "", "item": [ { "id": "5740cb70-9491-4963-bd1f-d2a8edcf65fa", "name": "Approve a pending mandate", "request": { "name": "Approve a pending mandate", "description": { "content": "Approves a mandate that is in PENDING_APPROVAL state, transitioning it\nto ACTIVE. Only mandates created with `require_approval: true` enter\nthis state. An audit event (MANDATE_APPROVED) is emitted.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "083fb4e6-33d2-4662-beb7-085a9c86c921", "name": "Mandate approved", "originalRequest": { "url": { "path": [ "mandates", ":id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mandate_id\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8aabeac3-1140-44a2-b6a5-b56cf2cd2535", "name": "Resource not found", "originalRequest": { "url": { "path": [ "mandates", ":id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34333f96-d5e9-4774-b9f3-a5aff6e9f9ed", "name": "State conflict", "originalRequest": { "url": { "path": [ "mandates", ":id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reject", "description": "", "item": [ { "id": "97fb62d4-9827-4a74-8a26-433720417a98", "name": "Reject a pending mandate", "request": { "name": "Reject a pending mandate", "description": { "content": "Rejects a mandate that is in PENDING_APPROVAL state, transitioning it\nto REVOKED. An audit event (MANDATE_REJECTED) is emitted.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d35f9a0f-c0df-41b4-8637-a846543a0c56", "name": "Mandate rejected", "originalRequest": { "url": { "path": [ "mandates", ":id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mandate_id\": \"\",\n \"status\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94cb55b4-4952-4d85-ac2c-aaa021ff8f21", "name": "Resource not found", "originalRequest": { "url": { "path": [ "mandates", ":id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afe7ca75-2710-46b2-9b5e-0d06d90fbc3b", "name": "State conflict", "originalRequest": { "url": { "path": [ "mandates", ":id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "events", "description": "", "item": [ { "id": "0a88c5f9-0055-4058-99fb-0bd1801f7c4b", "name": "Get audit events for a mandate", "request": { "name": "Get audit events for a mandate", "description": { "content": "Returns a paginated list of audit events for a specific mandate.\nEvents form an immutable, hash-chained audit trail.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1600ef5a-4ce6-4ed7-99c1-3f6a07be432a", "name": "Paginated list of events", "originalRequest": { "url": { "path": [ "mandates", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"EXECUTION_FAILED\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n },\n {\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"MANDATE_CREATED\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"SERVICE\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd700c1d-b2c6-42f5-be2d-7cd8b52616db", "name": "Authentication required", "originalRequest": { "url": { "path": [ "mandates", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39ff2527-b14c-48d5-809c-35d777ec4536", "name": "Resource not found", "originalRequest": { "url": { "path": [ "mandates", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "instruction", "description": "", "item": [ { "id": "7c843fe5-e83c-4151-93ab-2976d86adf91", "name": "Retrieve the decrypted user instruction for a mandate", "request": { "name": "Retrieve the decrypted user instruction for a mandate", "description": { "content": "Returns the decrypted original user instruction that was provided when\nthe mandate was created. Requires authentication and tenant ownership.\nAn INSTRUCTION_REVEALED audit event is emitted on each access.\n\nOnly available for mandates that were created with a Verifiable User\nInstruction (VUI). Returns 404 if no instruction exists.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "instruction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2d1a838a-e095-44fe-8393-71a6a406be54", "name": "Decrypted instruction", "originalRequest": { "url": { "path": [ "mandates", ":id", "instruction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"instruction_text\": \"\",\n \"instruction_hash\": \"\",\n \"instruction_timestamp\": \"\",\n \"instruction_channel\": \"chat\",\n \"principal_confirmation\": {\n \"method\": \"\",\n \"timestamp\": \"\",\n \"evidence_ref\": \"\"\n },\n \"mandate_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d2f9b74-b076-485d-b7ad-276ae0081250", "name": "Authentication required", "originalRequest": { "url": { "path": [ "mandates", ":id", "instruction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79246ae0-c328-491b-8bcc-a8f481dcb75d", "name": "Resource not found", "originalRequest": { "url": { "path": [ "mandates", ":id", "instruction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "evidence-pack", "description": "", "item": [ { "id": "6a106523-34a8-4103-a011-bda06a5007b8", "name": "Export a court-ready evidence pack", "request": { "name": "Export a court-ready evidence pack", "description": { "content": "Exports a comprehensive, court-ready evidence pack for a mandate containing:\n- Mandate snapshot at export time\n- Hash-chained audit event log\n- SD-JWT proof tokens from verification events\n- Case log hash (SHA-256 fingerprint over canonical event chain)\n- Export manifest with requester attribution, coverage, and recomputable digests\n- Immutable `EVIDENCE_PACK_EXPORTED` audit event recorded for the export operation\n- Issuer DID document reference for independent verification\n\nThe `case_log_hash` is a deterministic SHA-256 digest computed over the\ncanonical JSON representation of the event chain, enabling tamper detection.\n\nThe `export_manifest` binds the mandate snapshot, event chain, proof tokens,\nand export envelope to recomputable digests so offline reviewers can detect\ntampering in the export artifact.\n\nThe `schema_version` field allows forward-compatible evolution of the pack format.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "evidence-pack" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Scope the evidence pack to a specific verification event", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ad57c003-94a9-4431-a29b-cc2fa460a107", "name": "Evidence pack exported successfully", "originalRequest": { "url": { "path": [ "mandates", ":id", "evidence-pack" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Scope the evidence pack to a specific verification event", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"schema_version\": \"\",\n \"export_timestamp\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"mandate_snapshot\": {},\n \"event_chain\": [\n {\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"EXECUTION_OUTCOME_UNKNOWN\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n },\n {\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"EXECUTION_APPROVAL_SUPERSEDED\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n }\n ],\n \"event_count\": \"\",\n \"case_log_hash\": \"\",\n \"chain_integrity\": {\n \"first_event_hash\": \"\",\n \"last_event_hash\": \"\",\n \"genesis_verified\": \"\"\n },\n \"issuer\": {\n \"did\": \"\",\n \"did_document_url\": \"\"\n },\n \"proof_tokens\": [\n \"\",\n \"\"\n ],\n \"crypto_metadata\": {\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\",\n \"case_log_hash_algorithm\": \"\"\n },\n \"export_manifest\": {\n \"export_id\": \"\",\n \"generated_at\": \"\",\n \"generated_by\": {\n \"subject\": \"\",\n \"tenant_id\": \"\",\n \"auth_method\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n \"coverage\": {\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"schema_version\": \"\",\n \"event_count\": \"\",\n \"event_id_filter\": \"\"\n },\n \"digests\": {\n \"mandate_snapshot_hash\": \"\",\n \"event_chain_hash\": \"\",\n \"proof_tokens_hash\": \"\",\n \"manifest_hash\": \"\"\n },\n \"hash_algorithm\": \"\"\n },\n \"metadata\": {\n \"mandate_created_at\": \"\",\n \"mandate_status\": \"\",\n \"export_requested_by\": \"\",\n \"event_id_filter\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66c7d1f1-d583-4948-8e25-403e11b790ba", "name": "Authentication required", "originalRequest": { "url": { "path": [ "mandates", ":id", "evidence-pack" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Scope the evidence pack to a specific verification event", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9441ed6b-c8b7-4cc9-a133-a86cc4c1d586", "name": "Resource not found", "originalRequest": { "url": { "path": [ "mandates", ":id", "evidence-pack" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Scope the evidence pack to a specific verification event", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "vi-credential", "description": "", "item": [ { "id": "0cf6f999-7f25-4e11-bfd9-d2f6ddec9c7b", "name": "Issue a Verifiable Intent credential chain", "request": { "name": "Issue a Verifiable Intent credential chain", "description": { "content": "Generates a VI-spec compatible credential chain (L1 + L2) from an\nexisting active mandate. The chain can be presented to external\nverifiers that implement the Verifiable Intent specification.\n", "type": "text/plain" }, "url": { "path": [ "mandates", ":id", "vi-credential" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"agent_public_key\": {},\n \"principal_public_key\": {},\n \"principal_key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d6d5e3b4-a83d-46e4-847b-a76988c09a48", "name": "VI credential chain issued", "originalRequest": { "url": { "path": [ "mandates", ":id", "vi-credential" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"agent_public_key\": {},\n \"principal_public_key\": {},\n \"principal_key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"credential_chain\": {\n \"l1_credential\": \"\",\n \"l2_credential\": \"\",\n \"chain_id\": \"\",\n \"spec_version\": \"\"\n },\n \"format\": \"\",\n \"spec_version\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4f3de11-87b0-49cd-8543-40c9c1834bbd", "name": "Invalid request", "originalRequest": { "url": { "path": [ "mandates", ":id", "vi-credential" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"agent_public_key\": {},\n \"principal_public_key\": {},\n \"principal_key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e81f360-fa84-4d61-92e3-244db3cf668a", "name": "Authentication required", "originalRequest": { "url": { "path": [ "mandates", ":id", "vi-credential" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"agent_public_key\": {},\n \"principal_public_key\": {},\n \"principal_key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "225b6e89-255b-4032-b911-3095aee3c20b", "name": "Mandate not found", "originalRequest": { "url": { "path": [ "mandates", ":id", "vi-credential" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"audience\": \"\",\n \"nonce\": \"\",\n \"agent_public_key\": {},\n \"principal_public_key\": {},\n \"principal_key_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "consents", "description": "", "item": [ { "id": "65384ffd-0d2b-47a7-a664-dda1ca03a06a", "name": "List consent requests for a specific mandate", "request": { "name": "List consent requests for a specific mandate", "description": {}, "url": { "path": [ "mandates", ":id", "consents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of pending,approved,rejected,expired)", "type": "text/plain" }, "key": "status", "value": "pending" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2cc01067-a54f-4a69-9d99-31d1a0e9810c", "name": "Paginated list of consent requests for the mandate", "originalRequest": { "url": { "path": [ "mandates", ":id", "consents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of pending,approved,rejected,expired)", "type": "text/plain" }, "key": "status", "value": "pending" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"consent_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"agent_did\": \"\",\n \"approver_subject_id\": \"\",\n \"approver_display_name\": \"\",\n \"status\": \"APPROVED\",\n \"urgency\": \"CRITICAL\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"decision\": {\n \"decided_by\": \"\",\n \"decided_at\": \"\",\n \"comment\": \"\",\n \"auto_policy_id\": \"\"\n },\n \"execution\": {\n \"execution_id\": \"\",\n \"approval_digest\": \"\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"facts\": {},\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\"\n },\n \"require_mfa\": \"\",\n \"rules\": [\n \"\",\n \"\"\n ],\n \"purpose\": \"\"\n },\n \"notification\": {\n \"status\": \"SENDING\",\n \"channel\": \"email\",\n \"at\": \"\",\n \"reason\": \"RATE_LIMITED\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"consent_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"agent_did\": \"\",\n \"approver_subject_id\": \"\",\n \"approver_display_name\": \"\",\n \"status\": \"PENDING\",\n \"urgency\": \"LOW\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"decision\": {\n \"decided_by\": \"\",\n \"decided_at\": \"\",\n \"comment\": \"\",\n \"auto_policy_id\": \"\"\n },\n \"execution\": {\n \"execution_id\": \"\",\n \"approval_digest\": \"\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"facts\": {},\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\"\n },\n \"require_mfa\": \"\",\n \"rules\": [\n \"\",\n \"\"\n ],\n \"purpose\": \"\"\n },\n \"notification\": {\n \"status\": \"NOT_SENT\",\n \"channel\": \"email\",\n \"at\": \"\",\n \"reason\": \"RATE_LIMITED\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n }\n ],\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7e4f492-854b-4a48-adf2-ec8553d82736", "name": "Mandate not found", "originalRequest": { "url": { "path": [ "mandates", ":id", "consents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of pending,approved,rejected,expired)", "type": "text/plain" }, "key": "status", "value": "pending" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "verify", "description": "", "item": [ { "id": "d5d89893-0881-4dd4-8011-53d25aa533bc", "name": "Verify if an action is authorized by a mandate", "request": { "name": "Verify if an action is authorized by a mandate", "description": { "content": "Performance-critical endpoint. Target: < 50ms p99 latency (without PoM),\n< 200ms p99 (with PoM). Returns ALLOW or DENY with optional escalation\nmetadata and an optional Proof-of-Mandate Verifiable Credential.\n", "type": "text/plain" }, "url": { "path": [ "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Request a Proof-of-Mandate Verifiable Credential in the response.\nThe VC is an SD-JWT signed by the Mandaitor issuer DID.\n (This can only be one of sd-jwt-vc)", "type": "text/plain" }, "key": "pom", "value": "sd-jwt-vc" }, { "disabled": false, "description": { "content": "**@experimental** Request drift detection signals in the response.\nWhen `true`, the response includes a `semantic_signals` object with\nmulti-dimensional drift scoring. Drift signals are advisory only and\nNEVER affect the ALLOW/DENY decision. Requires the tenant to have\ndrift detection enabled.\n", "type": "text/plain" }, "key": "drift", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "dcdd0a57-c6cc-400e-9cb8-d6f285375725", "name": "Verification result with optional Proof-of-Mandate VC and experimental semantic signals", "originalRequest": { "url": { "path": [ "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Request a Proof-of-Mandate Verifiable Credential in the response.\nThe VC is an SD-JWT signed by the Mandaitor issuer DID.\n (This can only be one of sd-jwt-vc)", "type": "text/plain" }, "key": "pom", "value": "sd-jwt-vc" }, { "disabled": false, "description": { "content": "**@experimental** Request drift detection signals in the response.\nWhen `true`, the response includes a `semantic_signals` object with\nmulti-dimensional drift scoring. Drift signals are advisory only and\nNEVER affect the ALLOW/DENY decision. Requires the tenant to have\ndrift detection enabled.\n", "type": "text/plain" }, "key": "drift", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"decision\": \"ALLOW\",\n \"mandate_id\": \"\",\n \"event_id\": \"\",\n \"reason_codes\": [\n \"MFA_REQUIRED\",\n \"NO_MATCHING_MANDATE\"\n ],\n \"constraints_remaining\": {},\n \"evaluated_constraints\": [\n \"\",\n \"\"\n ],\n \"unevaluated_constraints\": [\n \"\",\n \"\"\n ],\n \"proof_of_mandate\": {\n \"compact\": \"\",\n \"payload\": {\n \"vct\": \"ProofOfMandate\",\n \"decision\": \"ALLOW\",\n \"mandate_id\": \"\",\n \"verification_event_id\": \"\",\n \"verification_timestamp\": \"\",\n \"requested_action\": \"\",\n \"requested_resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"principal_subject_id\": \"\",\n \"tenant_id\": \"\",\n \"reason_codes\": [\n \"\",\n \"\"\n ],\n \"constraints_snapshot\": {},\n \"latency_ms\": \"\",\n \"instruction_digest\": \"\",\n \"iss\": \"\",\n \"sub\": \"\",\n \"iat\": \"\",\n \"exp\": \"\",\n \"_sd_alg\": \"\"\n }\n },\n \"proof_token\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a7c2747-47c1-42ec-8825-5e69384047c4", "name": "Invalid request", "originalRequest": { "url": { "path": [ "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Request a Proof-of-Mandate Verifiable Credential in the response.\nThe VC is an SD-JWT signed by the Mandaitor issuer DID.\n (This can only be one of sd-jwt-vc)", "type": "text/plain" }, "key": "pom", "value": "sd-jwt-vc" }, { "disabled": false, "description": { "content": "**@experimental** Request drift detection signals in the response.\nWhen `true`, the response includes a `semantic_signals` object with\nmulti-dimensional drift scoring. Drift signals are advisory only and\nNEVER affect the ALLOW/DENY decision. Requires the tenant to have\ndrift detection enabled.\n", "type": "text/plain" }, "key": "drift", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64565d94-622e-49c8-9989-917ffab4e404", "name": "Authentication required", "originalRequest": { "url": { "path": [ "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Request a Proof-of-Mandate Verifiable Credential in the response.\nThe VC is an SD-JWT signed by the Mandaitor issuer DID.\n (This can only be one of sd-jwt-vc)", "type": "text/plain" }, "key": "pom", "value": "sd-jwt-vc" }, { "disabled": false, "description": { "content": "**@experimental** Request drift detection signals in the response.\nWhen `true`, the response includes a `semantic_signals` object with\nmulti-dimensional drift scoring. Drift signals are advisory only and\nNEVER affect the ALLOW/DENY decision. Requires the tenant to have\ndrift detection enabled.\n", "type": "text/plain" }, "key": "drift", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84c707e0-beb2-42a9-bbf5-3ceec55905a6", "name": "The decision could not be recorded in the audit log, so no decision is\ngiven (`error: AUDIT_UNAVAILABLE`). Decision events are recorded on a\ndurable queue before the response is sent and appended to the mandate's\nhash chain within seconds; this response means neither the queue nor the\nchain accepted the record. Retry after the `Retry-After` seconds; the\nretry gets a fresh decision and event id.", "originalRequest": { "url": { "path": [ "verify" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Request a Proof-of-Mandate Verifiable Credential in the response.\nThe VC is an SD-JWT signed by the Mandaitor issuer DID.\n (This can only be one of sd-jwt-vc)", "type": "text/plain" }, "key": "pom", "value": "sd-jwt-vc" }, { "disabled": false, "description": { "content": "**@experimental** Request drift detection signals in the response.\nWhen `true`, the response includes a `semantic_signals` object with\nmulti-dimensional drift scoring. Drift signals are advisory only and\nNEVER affect the ALLOW/DENY decision. Requires the tenant to have\ndrift detection enabled.\n", "type": "text/plain" }, "key": "drift", "value": "false" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "decisions", "description": "", "item": [ { "id": "3db985c2-75a3-4037-a388-ad9c751939a1", "name": "Decide one operation your enforcement point is about to perform", "request": { "name": "Decide one operation your enforcement point is about to perform", "description": { "content": "**Preview.** `/verify`'s successor for an integrator whose own\nenforcement point performs an agent's operation. Ask before you act,\nwith the tenant's API key (the `verify` scope), never from the agent:\nname the agent by its DID, the taxonomy business action, the one\nresource it acts on, and the facts you read from your own system.\nMandaitor decides as it decides an execution: every `ACTIVE` mandate\nnaming the agent counts, a `DENY` mandate wins, and an `ALLOW`\nmandate counts only if a person created or approved it and it names\nthe action exactly. Its time window, `max_amount`, cumulative limits,\n`amount_above` and `require_mfa` are checked on your facts; a mandate\nthat limits amounts needs an `amount` fact, as money.\n\n**ALLOW** carries `authorization`: a JWS (`typ`\n`mandaitor-authorization+jwt`, PS256) signed with the key the\nissuer's DID document lists as `#authorization-key-1`. It is bound to\nthe request's digest, to `audience` and to five minutes at most,\nnever past the mandate's expiry. Redeem it with\n`POST /decisions/{id}/redemption` immediately before you act; act\nonly if the redemption succeeds. It counts against the mandate's\ncumulative limits when it is given, whether or not it is redeemed.\n\n**REQUIRE_APPROVAL** and **DENY** carry no authorization. A decision\nrequest raises no approval: when a person would have to approve, the\nrequest fails closed.\n\nThe request digest is the SHA-256, `sha-256:` and base64url, of the\nRFC 8785 form of `{contract, tenant_id, agent, action, resource,\nfacts, audience}`; `mandate_id` and `purpose` are not part of it.\nThe SDK computes it as `decisionRequestDigest`.\n\nEvery answer is recorded on the audit chain before it is given. When\nit cannot be, nothing is given: 503 `AUDIT_UNAVAILABLE`. Each answer\ncounts 2 units against the monthly allowance, an ALLOW or not.\n", "type": "text/plain" }, "url": { "path": [ "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.decision-request/v1\",\n \"agent\": \"did:vfoazc:r'%~3\",\n \"action\": \"jba5idpbq_.yju.h9g0eze.uoira6wu.e8a4.hyajss1-clm.kdl-1.vkt7gw.w033-.blskmglo\",\n \"resource\": \"PuoZ6kd:s81voHw2g:Kuw-lhjPYv:sz~c9/Ne5U~e:i5NK0OkaVUo:s6L63q8D:tDoG:1V.:3ZsEwttFCj3:mCBHB2mJ:-9s8Z/utKg~g:hUIai8:SteW16dcL/ENpIDjI.U:XHKE.y3l/5PC:fQ3:oXP3k92:5OO:T:M:Cn1.R:1-3_W:kMTbuIoeq:~.5kvqstaq:w/UTgc28z:xH2_-2N:w5eA8D:cy:sYoBC/Rfi2Pri:Vy_P8:mg2r3.uY~\",\n \"facts\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\",\n \"key_8\": \"\",\n \"key_9\": \"\",\n \"key_10\": \"\",\n \"key_11\": \"\",\n \"key_12\": \"\",\n \"key_13\": \"\",\n \"key_14\": \"\",\n \"key_15\": \"\",\n \"key_16\": \"\"\n },\n \"audience\": \"?,G\\\";([aPA1USX(nV#\\\"cmx|Mw)zTIFT2:+(>I6aiP|cB,q7!{s|M41`8.ZY>,VjiSFP9+SD55q9kVFML4`Zes\\\"|d!hFd(I\\\\@N4`Jtm$Z6u3U^IOhQz|/n.;up0e[#17@xVrw{dGrorL@JE{{Bi@50e!Jg{v@<\",\n \"mandate_id\": \"mdt_LHZ7wiDfnlgXcLHCcg8nhJuoFfGdcSikvmp44kRGuQO4\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6887c82b-1646-4fce-9fc2-9fac33fbbee8", "name": "The decision. Only an `ALLOW` carries an authorization.", "originalRequest": { "url": { "path": [ "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.decision-request/v1\",\n \"agent\": \"did:vfoazc:r'%~3\",\n \"action\": \"jba5idpbq_.yju.h9g0eze.uoira6wu.e8a4.hyajss1-clm.kdl-1.vkt7gw.w033-.blskmglo\",\n \"resource\": \"PuoZ6kd:s81voHw2g:Kuw-lhjPYv:sz~c9/Ne5U~e:i5NK0OkaVUo:s6L63q8D:tDoG:1V.:3ZsEwttFCj3:mCBHB2mJ:-9s8Z/utKg~g:hUIai8:SteW16dcL/ENpIDjI.U:XHKE.y3l/5PC:fQ3:oXP3k92:5OO:T:M:Cn1.R:1-3_W:kMTbuIoeq:~.5kvqstaq:w/UTgc28z:xH2_-2N:w5eA8D:cy:sYoBC/Rfi2Pri:Vy_P8:mg2r3.uY~\",\n \"facts\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\",\n \"key_8\": \"\",\n \"key_9\": \"\",\n \"key_10\": \"\",\n \"key_11\": \"\",\n \"key_12\": \"\",\n \"key_13\": \"\",\n \"key_14\": \"\",\n \"key_15\": \"\",\n \"key_16\": \"\"\n },\n \"audience\": \"?,G\\\";([aPA1USX(nV#\\\"cmx|Mw)zTIFT2:+(>I6aiP|cB,q7!{s|M41`8.ZY>,VjiSFP9+SD55q9kVFML4`Zes\\\"|d!hFd(I\\\\@N4`Jtm$Z6u3U^IOhQz|/n.;up0e[#17@xVrw{dGrorL@JE{{Bi@50e!Jg{v@<\",\n \"mandate_id\": \"mdt_LHZ7wiDfnlgXcLHCcg8nhJuoFfGdcSikvmp44kRGuQO4\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contract\": \"mandaitor.decision/v1\",\n \"decision\": \"DENY\",\n \"code\": \"\",\n \"reason\": \"\",\n \"request_digest\": \"sha-256:tqt2V1LMHTRxcCAxHCGPpPN-INqQNmDZaDZGeFCGuz2\",\n \"event_id\": \"\",\n \"decided_at\": \"\",\n \"mandate_id\": \"\",\n \"fact\": \"\",\n \"constraints\": [\n \"\",\n \"\"\n ],\n \"approval_rules\": [\n \"REQUIRE_MFA\",\n \"REQUIRE_MFA\"\n ],\n \"decision_id\": \"dec_OVXQB17KSHICHAOV471ZV60KFH\",\n \"authorization\": \"\",\n \"expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c2f17f4-5950-4a8b-82b2-6b60b8d1ef21", "name": "`INVALID_REQUEST`: the body is not a valid\n`mandaitor.decision-request/v1` (an unknown key, a resource with\n`*` or a `{placeholder}`, an amount that is not money, more than 32\nfacts). `errors` lists each problem.", "originalRequest": { "url": { "path": [ "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.decision-request/v1\",\n \"agent\": \"did:vfoazc:r'%~3\",\n \"action\": \"jba5idpbq_.yju.h9g0eze.uoira6wu.e8a4.hyajss1-clm.kdl-1.vkt7gw.w033-.blskmglo\",\n \"resource\": \"PuoZ6kd:s81voHw2g:Kuw-lhjPYv:sz~c9/Ne5U~e:i5NK0OkaVUo:s6L63q8D:tDoG:1V.:3ZsEwttFCj3:mCBHB2mJ:-9s8Z/utKg~g:hUIai8:SteW16dcL/ENpIDjI.U:XHKE.y3l/5PC:fQ3:oXP3k92:5OO:T:M:Cn1.R:1-3_W:kMTbuIoeq:~.5kvqstaq:w/UTgc28z:xH2_-2N:w5eA8D:cy:sYoBC/Rfi2Pri:Vy_P8:mg2r3.uY~\",\n \"facts\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\",\n \"key_8\": \"\",\n \"key_9\": \"\",\n \"key_10\": \"\",\n \"key_11\": \"\",\n \"key_12\": \"\",\n \"key_13\": \"\",\n \"key_14\": \"\",\n \"key_15\": \"\",\n \"key_16\": \"\"\n },\n \"audience\": \"?,G\\\";([aPA1USX(nV#\\\"cmx|Mw)zTIFT2:+(>I6aiP|cB,q7!{s|M41`8.ZY>,VjiSFP9+SD55q9kVFML4`Zes\\\"|d!hFd(I\\\\@N4`Jtm$Z6u3U^IOhQz|/n.;up0e[#17@xVrw{dGrorL@JE{{Bi@50e!Jg{v@<\",\n \"mandate_id\": \"mdt_LHZ7wiDfnlgXcLHCcg8nhJuoFfGdcSikvmp44kRGuQO4\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"event_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "412be3de-8dff-4980-b73c-09ccb22695bd", "name": "Authentication required", "originalRequest": { "url": { "path": [ "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.decision-request/v1\",\n \"agent\": \"did:vfoazc:r'%~3\",\n \"action\": \"jba5idpbq_.yju.h9g0eze.uoira6wu.e8a4.hyajss1-clm.kdl-1.vkt7gw.w033-.blskmglo\",\n \"resource\": \"PuoZ6kd:s81voHw2g:Kuw-lhjPYv:sz~c9/Ne5U~e:i5NK0OkaVUo:s6L63q8D:tDoG:1V.:3ZsEwttFCj3:mCBHB2mJ:-9s8Z/utKg~g:hUIai8:SteW16dcL/ENpIDjI.U:XHKE.y3l/5PC:fQ3:oXP3k92:5OO:T:M:Cn1.R:1-3_W:kMTbuIoeq:~.5kvqstaq:w/UTgc28z:xH2_-2N:w5eA8D:cy:sYoBC/Rfi2Pri:Vy_P8:mg2r3.uY~\",\n \"facts\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\",\n \"key_8\": \"\",\n \"key_9\": \"\",\n \"key_10\": \"\",\n \"key_11\": \"\",\n \"key_12\": \"\",\n \"key_13\": \"\",\n \"key_14\": \"\",\n \"key_15\": \"\",\n \"key_16\": \"\"\n },\n \"audience\": \"?,G\\\";([aPA1USX(nV#\\\"cmx|Mw)zTIFT2:+(>I6aiP|cB,q7!{s|M41`8.ZY>,VjiSFP9+SD55q9kVFML4`Zes\\\"|d!hFd(I\\\\@N4`Jtm$Z6u3U^IOhQz|/n.;up0e[#17@xVrw{dGrorL@JE{{Bi@50e!Jg{v@<\",\n \"mandate_id\": \"mdt_LHZ7wiDfnlgXcLHCcg8nhJuoFfGdcSikvmp44kRGuQO4\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35bc4ec0-4eef-42ac-92c7-1c98e78dc7eb", "name": "The API key lacks the `verify` scope.", "originalRequest": { "url": { "path": [ "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.decision-request/v1\",\n \"agent\": \"did:vfoazc:r'%~3\",\n \"action\": \"jba5idpbq_.yju.h9g0eze.uoira6wu.e8a4.hyajss1-clm.kdl-1.vkt7gw.w033-.blskmglo\",\n \"resource\": \"PuoZ6kd:s81voHw2g:Kuw-lhjPYv:sz~c9/Ne5U~e:i5NK0OkaVUo:s6L63q8D:tDoG:1V.:3ZsEwttFCj3:mCBHB2mJ:-9s8Z/utKg~g:hUIai8:SteW16dcL/ENpIDjI.U:XHKE.y3l/5PC:fQ3:oXP3k92:5OO:T:M:Cn1.R:1-3_W:kMTbuIoeq:~.5kvqstaq:w/UTgc28z:xH2_-2N:w5eA8D:cy:sYoBC/Rfi2Pri:Vy_P8:mg2r3.uY~\",\n \"facts\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\",\n \"key_8\": \"\",\n \"key_9\": \"\",\n \"key_10\": \"\",\n \"key_11\": \"\",\n \"key_12\": \"\",\n \"key_13\": \"\",\n \"key_14\": \"\",\n \"key_15\": \"\",\n \"key_16\": \"\"\n },\n \"audience\": \"?,G\\\";([aPA1USX(nV#\\\"cmx|Mw)zTIFT2:+(>I6aiP|cB,q7!{s|M41`8.ZY>,VjiSFP9+SD55q9kVFML4`Zes\\\"|d!hFd(I\\\\@N4`Jtm$Z6u3U^IOhQz|/n.;up0e[#17@xVrw{dGrorL@JE{{Bi@50e!Jg{v@<\",\n \"mandate_id\": \"mdt_LHZ7wiDfnlgXcLHCcg8nhJuoFfGdcSikvmp44kRGuQO4\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d070e862-417e-43af-9db7-8253e8819f53", "name": "`AUDIT_UNAVAILABLE`: the decision could not be recorded on the\naudit chain, so none is given. Retry after `Retry-After`; the\nretry is decided afresh.", "originalRequest": { "url": { "path": [ "decisions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.decision-request/v1\",\n \"agent\": \"did:vfoazc:r'%~3\",\n \"action\": \"jba5idpbq_.yju.h9g0eze.uoira6wu.e8a4.hyajss1-clm.kdl-1.vkt7gw.w033-.blskmglo\",\n \"resource\": \"PuoZ6kd:s81voHw2g:Kuw-lhjPYv:sz~c9/Ne5U~e:i5NK0OkaVUo:s6L63q8D:tDoG:1V.:3ZsEwttFCj3:mCBHB2mJ:-9s8Z/utKg~g:hUIai8:SteW16dcL/ENpIDjI.U:XHKE.y3l/5PC:fQ3:oXP3k92:5OO:T:M:Cn1.R:1-3_W:kMTbuIoeq:~.5kvqstaq:w/UTgc28z:xH2_-2N:w5eA8D:cy:sYoBC/Rfi2Pri:Vy_P8:mg2r3.uY~\",\n \"facts\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\",\n \"key_5\": \"\",\n \"key_6\": \"\",\n \"key_7\": \"\",\n \"key_8\": \"\",\n \"key_9\": \"\",\n \"key_10\": \"\",\n \"key_11\": \"\",\n \"key_12\": \"\",\n \"key_13\": \"\",\n \"key_14\": \"\",\n \"key_15\": \"\",\n \"key_16\": \"\"\n },\n \"audience\": \"?,G\\\";([aPA1USX(nV#\\\"cmx|Mw)zTIFT2:+(>I6aiP|cB,q7!{s|M41`8.ZY>,VjiSFP9+SD55q9kVFML4`Zes\\\"|d!hFd(I\\\\@N4`Jtm$Z6u3U^IOhQz|/n.;up0e[#17@xVrw{dGrorL@JE{{Bi@50e!Jg{v@<\",\n \"mandate_id\": \"mdt_LHZ7wiDfnlgXcLHCcg8nhJuoFfGdcSikvmp44kRGuQO4\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"event_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "redemption", "description": "", "item": [ { "id": "c5992bd5-a864-42fd-8431-ea7b7785a1a6", "name": "Redeem an authorization, once, immediately before acting on it", "request": { "name": "Redeem an authorization, once, immediately before acting on it", "description": { "content": "**Preview.** Send the digest of the operation you are about to\nperform, computed by you, never copied from the answer. The\nredemption succeeds once, and only:\n- for the request the authorization was given for;\n- before its `exp`;\n- while the agent is active and has not been suspended or revoked\n since, and the mandate it rests on is active and unchanged since;\n- while no kill switch runs on the tenant, and none was requested\n since it was given.\n\nAct only on a 200. Every 409 means do not act, including\n`ALREADY_REDEEMED` after a retry whose first answer was lost: ask for\na new decision. Every redemption, refused or not, is recorded on the\naudit chain before it is answered; when it cannot be, the answer is\n503 and the authorization is left as it was. Redemptions are not\ncounted against the allowance.\n", "type": "text/plain" }, "url": { "path": [ "decisions", ":id", "redemption" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "dec_GX17XEOF0UNTUSUKALFZ4KPLE1", "key": "id", "disabled": false, "description": { "content": "(Required) The decision's `decision_id`, the authorization's `jti`.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_digest\": \"sha-256:tBCvMpANVxfdH-pPDPbvS5_jHS1vTPExpskWjEde__o\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "11b505bb-ad34-4fc8-8e99-626d270d9cf0", "name": "Redeemed. Act now; the authorization is spent.", "originalRequest": { "url": { "path": [ "decisions", ":id", "redemption" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The decision's `decision_id`, the authorization's `jti`.", "type": "text/plain" }, "type": "any", "value": "dec_GX17XEOF0UNTUSUKALFZ4KPLE1", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_digest\": \"sha-256:tBCvMpANVxfdH-pPDPbvS5_jHS1vTPExpskWjEde__o\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"decision_id\": \"\",\n \"redeemed_at\": \"\",\n \"event_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ced2e41b-bf31-4759-bfab-5f2a761e2fda", "name": "`INVALID_REQUEST`: the body is not `{ request_digest }`.", "originalRequest": { "url": { "path": [ "decisions", ":id", "redemption" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The decision's `decision_id`, the authorization's `jti`.", "type": "text/plain" }, "type": "any", "value": "dec_GX17XEOF0UNTUSUKALFZ4KPLE1", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_digest\": \"sha-256:tBCvMpANVxfdH-pPDPbvS5_jHS1vTPExpskWjEde__o\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"event_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c7ab9a-bde2-4d4b-872f-95af644efc76", "name": "Authentication required", "originalRequest": { "url": { "path": [ "decisions", ":id", "redemption" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The decision's `decision_id`, the authorization's `jti`.", "type": "text/plain" }, "type": "any", "value": "dec_GX17XEOF0UNTUSUKALFZ4KPLE1", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_digest\": \"sha-256:tBCvMpANVxfdH-pPDPbvS5_jHS1vTPExpskWjEde__o\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d22800f-5d89-4107-90a4-4fe1e0931c5d", "name": "The API key lacks the `verify` scope.", "originalRequest": { "url": { "path": [ "decisions", ":id", "redemption" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The decision's `decision_id`, the authorization's `jti`.", "type": "text/plain" }, "type": "any", "value": "dec_GX17XEOF0UNTUSUKALFZ4KPLE1", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_digest\": \"sha-256:tBCvMpANVxfdH-pPDPbvS5_jHS1vTPExpskWjEde__o\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da8a8cd7-4a66-4b76-825c-b20476645eaa", "name": "`DECISION_NOT_FOUND`: no authorization of this tenant has this id.", "originalRequest": { "url": { "path": [ "decisions", ":id", "redemption" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The decision's `decision_id`, the authorization's `jti`.", "type": "text/plain" }, "type": "any", "value": "dec_GX17XEOF0UNTUSUKALFZ4KPLE1", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_digest\": \"sha-256:tBCvMpANVxfdH-pPDPbvS5_jHS1vTPExpskWjEde__o\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"event_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d861c2b7-a7c0-4a18-aa97-b06b9c3ea0f1", "name": "Refused; do not act. `DIGEST_MISMATCH`: the authorization was\ngiven for another request. `ALREADY_REDEEMED`: it was redeemed\nbefore. `AUTHORIZATION_EXPIRED`: past its `exp`.\n`AGENT_NOT_ACTIVE`: the agent was suspended or revoked since it\nwas given. `MANDATE_NOT_ACTIVE`: the mandate it rests on is no\nlonger active, or changed since. `KILL_SWITCH`: the tenant's\nkill switch is running, or was requested since it was given.\n`event_id` names the refusal on the audit chain.", "originalRequest": { "url": { "path": [ "decisions", ":id", "redemption" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The decision's `decision_id`, the authorization's `jti`.", "type": "text/plain" }, "type": "any", "value": "dec_GX17XEOF0UNTUSUKALFZ4KPLE1", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_digest\": \"sha-256:tBCvMpANVxfdH-pPDPbvS5_jHS1vTPExpskWjEde__o\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"event_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe08070f-fac4-4013-b594-eb64fee36f96", "name": "`AUDIT_UNAVAILABLE`: the redemption could not be recorded, so it\nwas taken back. Retry after `Retry-After`.", "originalRequest": { "url": { "path": [ "decisions", ":id", "redemption" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The decision's `decision_id`, the authorization's `jti`.", "type": "text/plain" }, "type": "any", "value": "dec_GX17XEOF0UNTUSUKALFZ4KPLE1", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"request_digest\": \"sha-256:tBCvMpANVxfdH-pPDPbvS5_jHS1vTPExpskWjEde__o\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"event_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "eudi", "description": "", "item": [ { "name": "sessions", "description": "", "item": [ { "id": "0367d55f-aae2-4f11-bc30-9a2d0b2306da", "name": "Initiate EUDI Wallet verification session", "request": { "name": "Initiate EUDI Wallet verification session", "description": { "content": "Creates a new OpenID4VP session for EUDI Wallet identity verification.\nReturns a QR code URI (cross-device) and deep link URI (same-device)\nthat the user scans/opens with their EUDI Wallet.\n", "type": "text/plain" }, "url": { "path": [ "eudi", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"presentation_definition_id\": \"mandaitor-pid-standard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "db8e6b3f-cadf-438c-8eaf-4f70bd1dfa0c", "name": "Session created", "originalRequest": { "url": { "path": [ "eudi", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"presentation_definition_id\": \"mandaitor-pid-standard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session_id\": \"\",\n \"status\": \"PENDING\",\n \"request_uri\": \"\",\n \"qr_code_uri\": \"\",\n \"deep_link_uri\": \"\",\n \"expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "436a0026-eca7-41c4-94e7-4fe887eb2e6d", "name": "Invalid request", "originalRequest": { "url": { "path": [ "eudi", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"presentation_definition_id\": \"mandaitor-pid-standard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a34d3bb-ddac-4d77-9e0c-e6f89978a410", "name": "Authentication required", "originalRequest": { "url": { "path": [ "eudi", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"presentation_definition_id\": \"mandaitor-pid-standard\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{sessionId}", "description": "", "item": [ { "id": "659b886d-4657-4c66-9d90-65b980d46c17", "name": "Poll EUDI session status", "request": { "name": "Poll EUDI session status", "description": { "content": "Polls the status of an EUDI Wallet verification session.\nReturns the resolved identity when the session is completed.\n", "type": "text/plain" }, "url": { "path": [ "eudi", "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8267407c-3ebc-40f2-98e5-fe361cd42c43", "name": "Session status", "originalRequest": { "url": { "path": [ "eudi", "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session_id\": \"\",\n \"status\": \"COMPLETED\",\n \"created_at\": \"\",\n \"presentation_definition_id\": \"\",\n \"resolved_identity\": {\n \"subject_id\": \"\",\n \"subject_type\": \"NATURAL_PERSON\",\n \"provider\": \"EUDI_WALLET\",\n \"display_name\": \"\",\n \"assurance_level\": \"HIGH\",\n \"eidas_attributes\": {\n \"unique_id\": \"\",\n \"family_name\": \"\",\n \"given_name\": \"\",\n \"birth_date\": \"\",\n \"nationality\": \"\",\n \"pid_issuer\": \"\",\n \"issuing_country\": \"\",\n \"assurance_level\": \"LOW\"\n }\n },\n \"verified_at\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2724e74e-779f-43ea-9c10-106e36c3c1f4", "name": "Resource not found", "originalRequest": { "url": { "path": [ "eudi", "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "response", "description": "", "item": [ { "id": "77c03f7d-69e4-41f3-9ce8-004e192f9621", "name": "Receive VP Token from EUDI Wallet", "request": { "name": "Receive VP Token from EUDI Wallet", "description": { "content": "Receives the VP Token from the EUDI Wallet via direct_post response mode.\nThis endpoint is called by the wallet after user consent. No authentication\nrequired as the wallet POSTs directly.\n", "type": "text/plain" }, "url": { "path": [ "eudi", "sessions", ":sessionId", "response" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vp_token\": \"\",\n \"presentation_submission\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f5b414db-d6ab-48af-970e-2bdb9b204853", "name": "VP Token accepted and verified", "originalRequest": { "url": { "path": [ "eudi", "sessions", ":sessionId", "response" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vp_token\": \"\",\n \"presentation_submission\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"COMPLETED\",\n \"session_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87687851-9ae0-4a36-a24c-c51c6a4b1246", "name": "Invalid request", "originalRequest": { "url": { "path": [ "eudi", "sessions", ":sessionId", "response" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vp_token\": \"\",\n \"presentation_submission\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "request", "description": "", "item": [ { "name": "{requestId}", "description": "", "item": [ { "id": "829b277f-34e5-4b1a-8ab4-5d9e399e9007", "name": "Serve OpenID4VP Authorization Request Object", "request": { "name": "Serve OpenID4VP Authorization Request Object", "description": { "content": "Serves the signed JWT Authorization Request Object that the EUDI Wallet\nfetches after scanning the QR code. Returns the JWT directly with\ncontent type application/oauth-authz-req+jwt.\n", "type": "text/plain" }, "url": { "path": [ "eudi", "request", ":requestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "requestId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/oauth-authz-req+jwt" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f053b1c4-6129-4fcd-9360-0abc162d15a2", "name": "Signed JWT Request Object", "originalRequest": { "url": { "path": [ "eudi", "request", ":requestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "requestId" } ] }, "header": [ { "key": "Accept", "value": "application/oauth-authz-req+jwt" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/oauth-authz-req+jwt" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e71f6d5-fba2-4aae-b3a8-d713f3428b61", "name": "Resource not found", "originalRequest": { "url": { "path": [ "eudi", "request", ":requestId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "requestId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "tenants", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "name": "identity-providers", "description": "", "item": [ { "id": "74fe4745-fbe0-447a-869a-e5c7122a36de", "name": "Get tenant identity provider configuration", "request": { "name": "Get tenant identity provider configuration", "description": {}, "url": { "path": [ "tenants", ":id", "identity-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e50d8fa5-b4fe-458b-991f-227ed7b19d8b", "name": "Identity provider configuration", "originalRequest": { "url": { "path": [ "tenants", ":id", "identity-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"identity_providers\": {\n \"enabled_providers\": [\n \"OKTA\",\n \"COGNITO\"\n ],\n \"auth0\": {\n \"domain\": \"\",\n \"audience\": \"\",\n \"client_id\": \"\"\n },\n \"okta\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"entra\": {\n \"tenant_id\": \"\",\n \"client_id\": \"\"\n },\n \"eudi\": {\n \"rp_id\": \"\",\n \"presentation_policies\": [\n \"\",\n \"\"\n ]\n },\n \"google\": {\n \"client_id\": \"\",\n \"hosted_domain\": \"\"\n },\n \"aws_iam_idc\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"generic_oidc\": {\n \"name\": \"\",\n \"issuer\": \"\",\n \"audience\": \"\",\n \"subject_prefix\": \"na12g88\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df9d8233-6c18-4835-ac43-c474e7775600", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "identity-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f8d1511-b727-4e9f-b945-a335614b1915", "name": "Update tenant identity provider configuration", "request": { "name": "Update tenant identity provider configuration", "description": {}, "url": { "path": [ "tenants", ":id", "identity-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled_providers\": [\n \"COGNITO\",\n \"EUDI_WALLET\"\n ],\n \"auth0\": {\n \"domain\": \"\",\n \"audience\": \"\",\n \"client_id\": \"\"\n },\n \"okta\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"entra\": {\n \"tenant_id\": \"\",\n \"client_id\": \"\"\n },\n \"eudi\": {\n \"rp_id\": \"\",\n \"presentation_policies\": [\n \"\",\n \"\"\n ]\n },\n \"google\": {\n \"client_id\": \"\",\n \"hosted_domain\": \"\"\n },\n \"aws_iam_idc\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"generic_oidc\": {\n \"name\": \"\",\n \"issuer\": \"\",\n \"audience\": \"\",\n \"subject_prefix\": \"u9r4j\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "424f726e-e5f9-4d76-909a-72b1cf54dc00", "name": "Configuration updated", "originalRequest": { "url": { "path": [ "tenants", ":id", "identity-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled_providers\": [\n \"COGNITO\",\n \"EUDI_WALLET\"\n ],\n \"auth0\": {\n \"domain\": \"\",\n \"audience\": \"\",\n \"client_id\": \"\"\n },\n \"okta\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"entra\": {\n \"tenant_id\": \"\",\n \"client_id\": \"\"\n },\n \"eudi\": {\n \"rp_id\": \"\",\n \"presentation_policies\": [\n \"\",\n \"\"\n ]\n },\n \"google\": {\n \"client_id\": \"\",\n \"hosted_domain\": \"\"\n },\n \"aws_iam_idc\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"generic_oidc\": {\n \"name\": \"\",\n \"issuer\": \"\",\n \"audience\": \"\",\n \"subject_prefix\": \"u9r4j\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"identity_providers\": {\n \"enabled_providers\": [\n \"OKTA\",\n \"COGNITO\"\n ],\n \"auth0\": {\n \"domain\": \"\",\n \"audience\": \"\",\n \"client_id\": \"\"\n },\n \"okta\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"entra\": {\n \"tenant_id\": \"\",\n \"client_id\": \"\"\n },\n \"eudi\": {\n \"rp_id\": \"\",\n \"presentation_policies\": [\n \"\",\n \"\"\n ]\n },\n \"google\": {\n \"client_id\": \"\",\n \"hosted_domain\": \"\"\n },\n \"aws_iam_idc\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"generic_oidc\": {\n \"name\": \"\",\n \"issuer\": \"\",\n \"audience\": \"\",\n \"subject_prefix\": \"na12g88\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0c52b28-9f68-42e9-adeb-15826502ff31", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "identity-providers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled_providers\": [\n \"COGNITO\",\n \"EUDI_WALLET\"\n ],\n \"auth0\": {\n \"domain\": \"\",\n \"audience\": \"\",\n \"client_id\": \"\"\n },\n \"okta\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"entra\": {\n \"tenant_id\": \"\",\n \"client_id\": \"\"\n },\n \"eudi\": {\n \"rp_id\": \"\",\n \"presentation_policies\": [\n \"\",\n \"\"\n ]\n },\n \"google\": {\n \"client_id\": \"\",\n \"hosted_domain\": \"\"\n },\n \"aws_iam_idc\": {\n \"issuer\": \"\",\n \"audience\": \"\"\n },\n \"generic_oidc\": {\n \"name\": \"\",\n \"issuer\": \"\",\n \"audience\": \"\",\n \"subject_prefix\": \"u9r4j\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "api-keys", "description": "", "item": [ { "id": "7652cd26-224d-42a9-8693-8a3d912de4d1", "name": "List API keys for the tenant (metadata only)", "request": { "name": "List API keys for the tenant (metadata only)", "description": { "content": "Returns metadata for every API key owned by the tenant. The raw key is\nonly available at creation time via `POST /tenants/{id}/api-keys`; this\nendpoint never returns the raw key or its hash. The tenant is taken\nfrom the authenticated caller — the path parameter must match, or the\nrequest is rejected with 403. Requires Cognito JWT.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "93c76f75-f419-4bb3-b109-f0694094be2f", "name": "List of API keys", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"key_id\": \"\",\n \"name\": \"\",\n \"environment\": \"test\",\n \"created_at\": \"\",\n \"status\": \"REVOKED\",\n \"last_four\": \"\",\n \"scopes\": [\n \"verify\",\n \"verify\"\n ]\n },\n {\n \"key_id\": \"\",\n \"name\": \"\",\n \"environment\": \"live\",\n \"created_at\": \"\",\n \"status\": \"REVOKED\",\n \"last_four\": \"\",\n \"scopes\": [\n \"mandates:read\",\n \"mandates:read\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89311ad2-5151-4782-b3f1-efd49a6bf003", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69d51558-d89f-4f6e-b0be-86121b91fc31", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5fc4916f-b0bb-4702-8f5f-bc0f6773778d", "name": "Generate a new API key for the tenant", "request": { "name": "Generate a new API key for the tenant", "description": { "content": "Generates a new API key for a tenant. The raw key is returned only once\nin the response and cannot be retrieved again. Requires Cognito JWT.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"environment\": \"live\",\n \"scopes\": [\n \"verify\",\n \"verify\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "cacf7122-a4cf-4bd1-8767-809334212a27", "name": "API key created", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"environment\": \"live\",\n \"scopes\": [\n \"verify\",\n \"verify\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_id\": \"\",\n \"api_key\": \"\",\n \"name\": \"\",\n \"environment\": \"live\",\n \"scopes\": [\n \"verify\",\n \"mandates:write\"\n ],\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d61fc56-a29f-40bb-9cbd-aa55903c59ba", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"environment\": \"live\",\n \"scopes\": [\n \"verify\",\n \"verify\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{keyId}", "description": "", "item": [ { "id": "ca81f502-1f1c-4e84-bff6-6adab951d864", "name": "Revoke an API key for the tenant", "request": { "name": "Revoke an API key for the tenant", "description": { "content": "Flips the per-key row to `status: \"REVOKED\"`. The authorizer reads\nper-key rows directly, so the key stops authenticating on the next\nrequest — other ACTIVE keys for the same tenant keep working.\nIdempotent for already-revoked keys. The tenant path parameter must\nmatch the authenticated caller. Requires Cognito JWT.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "api-keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "keyId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d7a31937-7320-4050-aa6e-4c115200a062", "name": "Key revoked (no content)", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "keyId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5108443-def5-4e4a-97d8-74d602e3ed61", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "keyId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58f0b502-f865-4ce5-adb0-6f3292d84237", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "keyId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "954c6333-44a5-4ef5-9b21-cd01c5c03e95", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "api-keys", ":keyId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "keyId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "roles", "description": "", "item": [ { "id": "b4435e75-8f52-4abf-b087-9974d9dea3af", "name": "List tenant role assignments", "request": { "name": "List tenant role assignments", "description": { "content": "Returns the persisted role-assignment policy rows for a tenant. Each\nassignment binds a canonical subject ID to tenant-scoped roles and\nderived effective permissions. The tenant path parameter must match the\nauthenticated caller unless the caller is a platform administrator.\nRequires `tenant:read` permission.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9cd39250-3ae2-49a8-afcd-fd44c0e64cf6", "name": "Tenant role assignments returned", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"assignments\": [\n {\n \"tenant_id\": \"\",\n \"subject_id\": \"\",\n \"subject_type\": \"SERVICE\",\n \"roles\": [\n \"service\",\n \"tenant_operator\"\n ],\n \"permissions\": [\n \"tenant:read\",\n \"*\"\n ],\n \"status\": \"REVOKED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"assigned_by\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"revoked_at\": \"\",\n \"revoked_by\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"subject_id\": \"\",\n \"subject_type\": \"SERVICE\",\n \"roles\": [\n \"tenant_viewer\",\n \"service\"\n ],\n \"permissions\": [\n \"mandates:read\",\n \"platform:onboarding:read\"\n ],\n \"status\": \"REVOKED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"assigned_by\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"revoked_at\": \"\",\n \"revoked_by\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aea0455f-a7c1-48ed-aca8-8efc6292f56f", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ad49f3b-43ee-4f36-80b3-315aa579d43c", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{subjectId}", "description": "", "item": [ { "id": "ca203715-21c4-4d76-94a5-5ea6ade73c74", "name": "Create or update a tenant role assignment", "request": { "name": "Create or update a tenant role assignment", "description": { "content": "Creates or replaces the tenant-scoped role assignment for the canonical\nsubject ID in the path. `platform_admin` and `platform:*` grants are\nrejected because tenant policy can only delegate tenant-scoped access.\nRole-derived permissions and any explicit tenant permissions are stored\nas the assignment's effective permission set. Emits an immutable\n`TENANT_ROLE_ASSIGNED` audit event. Requires `tenant:write` permission.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId", "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"roles\": [\n \"tenant_operator\"\n ],\n \"subject_type\": \"NATURAL_PERSON\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"permissions\": [\n \"mandates:write\",\n \"mandates:write\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "055e30b4-2046-4263-8cf4-c960abeb4271", "name": "Tenant role assignment created or updated", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"roles\": [\n \"tenant_operator\"\n ],\n \"subject_type\": \"NATURAL_PERSON\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"permissions\": [\n \"mandates:write\",\n \"mandates:write\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"assignment\": {\n \"tenant_id\": \"\",\n \"subject_id\": \"\",\n \"subject_type\": \"AGENT\",\n \"roles\": [\n \"platform_admin\",\n \"platform_admin\"\n ],\n \"permissions\": [\n \"tenant:api-keys:read\",\n \"tenant:api-keys:write\"\n ],\n \"status\": \"REVOKED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"assigned_by\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"revoked_at\": \"\",\n \"revoked_by\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9395f752-525e-4618-bd8c-a836f9e95fe1", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"roles\": [\n \"tenant_operator\"\n ],\n \"subject_type\": \"NATURAL_PERSON\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"permissions\": [\n \"mandates:write\",\n \"mandates:write\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0f6f65b-ca53-409d-8d5d-2bdcf31f0bb6", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"roles\": [\n \"tenant_operator\"\n ],\n \"subject_type\": \"NATURAL_PERSON\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"permissions\": [\n \"mandates:write\",\n \"mandates:write\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e72edfb4-6bda-4ba4-b0a2-8ed1e60fd833", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"roles\": [\n \"tenant_operator\"\n ],\n \"subject_type\": \"NATURAL_PERSON\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"permissions\": [\n \"mandates:write\",\n \"mandates:write\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b6d0768-e62b-40af-be26-6bb17a0c2b26", "name": "Revoke a tenant role assignment", "request": { "name": "Revoke a tenant role assignment", "description": { "content": "Revokes the tenant-scoped role assignment for the canonical subject ID\nby deleting the persisted policy row. The next authorizer evaluation no\nlonger enriches the subject with those tenant roles or permissions.\nEmits an immutable `TENANT_ROLE_REVOKED` audit event. The operation is\nidempotent. Requires `tenant:write` permission.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId", "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "07612246-458e-44d0-8abf-f34caed8f704", "name": "Tenant role assignment revoked (no content)", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b0c4a5e-89a6-447a-9137-9ecb89d1b69f", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f1af192-c97f-4acd-bc05-f4d684a9769d", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "835dfc38-e240-43ef-a867-1825623375d5", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "roles", ":subjectId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "users", "description": "", "item": [ { "name": "{subjectId}", "description": "", "item": [ { "name": "workspaces", "description": "", "item": [ { "id": "f81eec58-e5f9-4986-a341-32c91184937b", "name": "Get workspace entitlements for a tenant user by tenant ID", "request": { "name": "Get workspace entitlements for a tenant user by tenant ID", "description": { "content": "Returns workspace access for the URL-encoded canonical subject ID within\nthe tenant identified by the path parameter. Tenant-scoped callers may\nonly use their own tenant ID unless the authorizer grants platform-admin\nprivileges. Reading another subject's entitlement requires `tenant:read`\npermission. If no explicit entitlement exists, default workspace access\nis resolved using the caller's tenant RBAC context.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id", "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be read.", "type": "text/plain" } }, { "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId", "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2e8ceaea-15a6-4db3-9c70-9e2d4e95d1dc", "name": "Tenant user's workspace entitlements returned", "originalRequest": { "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be read.", "type": "text/plain" }, "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" }, "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"user_id\": \"\",\n \"workspaces\": {\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"updated_at\": \"\",\n \"source\": \"explicit\",\n \"granted_by\": \"\",\n \"granted_at\": \"\",\n \"updated_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81adc53b-1901-4394-b0c7-7649dc2556b1", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be read.", "type": "text/plain" }, "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" }, "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4e2cd08-b3dc-436d-8822-73eb9bd5b558", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be read.", "type": "text/plain" }, "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" }, "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dbf72c8-0a02-44b6-9d94-85d32eab02bb", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be read.", "type": "text/plain" }, "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" }, "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "543ba3d6-0759-400d-b476-29e62ba4b632", "name": "Update workspace entitlements for a tenant user by tenant ID", "request": { "name": "Update workspace entitlements for a tenant user by tenant ID", "description": { "content": "Creates or replaces the explicit workspace entitlement row for the\nURL-encoded canonical subject ID within the tenant identified by the path\nparameter. Tenant-scoped callers may only use their own tenant ID unless\nthe authorizer grants platform-admin privileges. Setting both workspace\nflags to `false` stores the entitlement as `REVOKED` and causes both\nworkspaces to be disabled in the response. Emits an immutable\n`WORKSPACE_ENTITLEMENT_UPDATED` audit event. Requires `tenant:write`\npermission.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id", "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be updated.", "type": "text/plain" } }, { "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId", "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "97eb9ceb-0bdb-45b0-87c5-a8232257b53b", "name": "Tenant user's workspace entitlements updated", "originalRequest": { "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be updated.", "type": "text/plain" }, "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" }, "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"user_id\": \"\",\n \"workspaces\": {\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"updated_at\": \"\",\n \"source\": \"explicit\",\n \"granted_by\": \"\",\n \"granted_at\": \"\",\n \"updated_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20364c22-f14c-4c9c-bb32-bd72b4bbe625", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be updated.", "type": "text/plain" }, "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" }, "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67f6aa45-58de-4fba-9cb4-e610614a4d60", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be updated.", "type": "text/plain" }, "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" }, "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50188333-1821-4972-bfa5-b3414bb60c77", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Tenant ID whose user workspace entitlements should be updated.", "type": "text/plain" }, "type": "any", "value": "Q4E69iJI8XE77pZs", "key": "id" }, { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID or email address recorded in tenant access assignments.", "type": "text/plain" }, "type": "any", "value": "ctq5juu4Nlg0QLhmDmpPzBdvtIGNAqHnrQ-n-d/kVa.PAULgsufeS66eRZKL4J", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "events", "description": "", "item": [ { "id": "94233b88-fbef-4e19-bb08-4caedb05ee28", "name": "List audit events for the tenant (all mandates)", "request": { "name": "List audit events for the tenant (all mandates)", "description": { "content": "Tenant-scoped audit feed used by the dashboard Overview / Recent\nActivity. Returns events in descending timestamp order across all\nof the tenant's mandates. For a per-mandate timeline use\n`GET /events?mandate_id=…` instead. The tenant path parameter\nmust match the authenticated caller. Requires Cognito JWT.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type (applied after the tenant-scoped query).", "type": "text/plain" }, "key": "event_type", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a19d83ca-5a6e-44fd-be97-fcc3314b4df1", "name": "List of audit events", "originalRequest": { "url": { "path": [ "tenants", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type (applied after the tenant-scoped query).", "type": "text/plain" }, "key": "event_type", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"mandate_id\": \"\",\n \"tenant_id\": \"\",\n \"timestamp\": \"\"\n },\n {\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"mandate_id\": \"\",\n \"tenant_id\": \"\",\n \"timestamp\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4cab445-547f-4938-bf74-98a4f4754df6", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type (applied after the tenant-scoped query).", "type": "text/plain" }, "key": "event_type", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10bad65e-98ea-43fe-b171-c6d6609ed3db", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type (applied after the tenant-scoped query).", "type": "text/plain" }, "key": "event_type", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "audit-export", "description": "", "item": [ { "id": "d23132e7-f6db-4a6b-a102-2fb80ddcc3f5", "name": "Export tenant audit events for SIEM ingestion", "request": { "name": "Export tenant audit events for SIEM ingestion", "description": { "content": "Exports a tenant-scoped audit event slice in descending timestamp order\nfor SIEM, GRC, and offline audit tooling. The tenant path parameter must\nmatch the authenticated caller unless the caller is a platform admin.\nRequires the `events:export` permission, which is granted to tenant\nadministrators and tenant auditors.\n\nThe `format` parameter selects the interchange representation:\n\n- `json` (default) — Mandaitor's native envelope with pagination\n metadata in the body.\n- `xes` — eXtensible Event Stream (IEEE 1849) for process mining\n (ProM, Celonis, Apromore, Signavio). One trace per mandate, ordered\n oldest-first, with the standard `concept`, `time`, `org`, `lifecycle`\n and `identity` extensions declared.\n- `cloudevents` — CNCF CloudEvents 1.0 JSON batch for event meshes\n (Knative, Event Grid, Kafka). Attribute names follow the\n specification's lowercase-alphanumeric constraint, so Mandaitor's\n snake_case fields appear as `tenantid`, `mandateid` and `eventhash`.\n\nXES and CloudEvents have no envelope for pagination, so the cursor,\nexport id and event count are returned as `X-Mandaitor-*` response\nheaders instead. These headers are listed in\n`Access-Control-Expose-Headers` so browser clients can read them.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "audit-export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Interchange format for the export. Case-insensitive. An unsupported\nvalue returns 400 rather than falling back to JSON, so a caller\ncannot mistake a downgraded payload for a successful export.\n (This can only be one of json,xes,cloudevents)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "Maximum number of audit events to include in this export page.", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type for SIEM-specific routing or replay windows.", "type": "text/plain" }, "key": "event_type", "value": "" }, { "disabled": false, "description": { "content": "Inclusive lower bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "from_timestamp", "value": "" }, { "disabled": false, "description": { "content": "Inclusive upper bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "to_timestamp", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "715e424d-72a4-4814-ad3c-18bf3f8e0ee7", "name": "Tenant audit export payload. The media type follows the requested\n`format`.", "originalRequest": { "url": { "path": [ "tenants", ":id", "audit-export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Interchange format for the export. Case-insensitive. An unsupported\nvalue returns 400 rather than falling back to JSON, so a caller\ncannot mistake a downgraded payload for a successful export.\n (This can only be one of json,xes,cloudevents)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "Maximum number of audit events to include in this export page.", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type for SIEM-specific routing or replay windows.", "type": "text/plain" }, "key": "event_type", "value": "" }, { "disabled": false, "description": { "content": "Inclusive lower bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "from_timestamp", "value": "" }, { "disabled": false, "description": { "content": "Inclusive upper bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "to_timestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Attachment filename, with the extension matching the format.", "type": "text/plain" }, "key": "Content-Disposition", "value": "" }, { "disabled": false, "description": { "content": "Pagination cursor for the next page, present only when more\nevents remain. Set for the `xes` and `cloudevents` formats,\nwhich carry no envelope; the `json` format returns the cursor\nas `next_cursor` in the body instead.\n", "type": "text/plain" }, "key": "X-Mandaitor-Next-Cursor", "value": "" }, { "disabled": false, "description": { "content": "Export identifier, mirrored from the audit trail entry.", "type": "text/plain" }, "key": "X-Mandaitor-Export-Id", "value": "" }, { "disabled": false, "description": { "content": "Number of events contained in this page.", "type": "text/plain" }, "key": "X-Mandaitor-Event-Count", "value": "" } ], "body": "{\n \"export_id\": \"\",\n \"tenant_id\": \"\",\n \"generated_at\": \"\",\n \"event_count\": \"\",\n \"items\": [\n {\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"TENANT_ROLE_ASSIGNED\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"AI_AGENT\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n },\n {\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"TENANT_AUDIT_EXPORTED\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"HUMAN\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ad75cf-5aa8-46f3-b973-01869ee54616", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "audit-export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Interchange format for the export. Case-insensitive. An unsupported\nvalue returns 400 rather than falling back to JSON, so a caller\ncannot mistake a downgraded payload for a successful export.\n (This can only be one of json,xes,cloudevents)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "Maximum number of audit events to include in this export page.", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type for SIEM-specific routing or replay windows.", "type": "text/plain" }, "key": "event_type", "value": "" }, { "disabled": false, "description": { "content": "Inclusive lower bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "from_timestamp", "value": "" }, { "disabled": false, "description": { "content": "Inclusive upper bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "to_timestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65d50c44-a6b2-4167-8b48-224b2e225bd8", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "audit-export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Interchange format for the export. Case-insensitive. An unsupported\nvalue returns 400 rather than falling back to JSON, so a caller\ncannot mistake a downgraded payload for a successful export.\n (This can only be one of json,xes,cloudevents)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "Maximum number of audit events to include in this export page.", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type for SIEM-specific routing or replay windows.", "type": "text/plain" }, "key": "event_type", "value": "" }, { "disabled": false, "description": { "content": "Inclusive lower bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "from_timestamp", "value": "" }, { "disabled": false, "description": { "content": "Inclusive upper bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "to_timestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d766477e-d607-49c3-8dbc-bdc5159232b1", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "audit-export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Interchange format for the export. Case-insensitive. An unsupported\nvalue returns 400 rather than falling back to JSON, so a caller\ncannot mistake a downgraded payload for a successful export.\n (This can only be one of json,xes,cloudevents)", "type": "text/plain" }, "key": "format", "value": "json" }, { "disabled": false, "description": { "content": "Maximum number of audit events to include in this export page.", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Optional filter on event_type for SIEM-specific routing or replay windows.", "type": "text/plain" }, "key": "event_type", "value": "" }, { "disabled": false, "description": { "content": "Inclusive lower bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "from_timestamp", "value": "" }, { "disabled": false, "description": { "content": "Inclusive upper bound for the audit-event timestamp sort key.", "type": "text/plain" }, "key": "to_timestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "widget-config", "description": "", "item": [ { "id": "877bf3f0-c45f-4e98-9e34-2d517db712b5", "name": "Get tenant widget configuration", "request": { "name": "Get tenant widget configuration", "description": { "content": "Retrieves the widget configuration for a tenant. Returns the latest\nversion by default, or a specific version if the version query parameter is provided.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "widget-config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9e2ec8ea-f5d7-4c71-9a83-bbf38a099090", "name": "Widget configuration", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"widget_id\": \"\",\n \"identity_providers\": [\n {\n \"provider\": \"entra_id\",\n \"enabled\": \"\",\n \"config\": {}\n },\n {\n \"provider\": \"eidas_eudi\",\n \"enabled\": \"\",\n \"config\": {}\n }\n ],\n \"taxonomy_libraries\": [\n \"\",\n \"\"\n ],\n \"branding\": {\n \"primary_color\": \"\",\n \"logo_url\": \"\",\n \"company_name\": \"\"\n },\n \"approval_workflow\": {\n \"require_principal_approval\": \"\",\n \"require_admin_approval\": \"\",\n \"auto_approve_trusted_idps\": \"\"\n },\n \"webhook_url\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca277c93-dee8-4376-a649-447811b40d29", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e2a1796-77e5-459d-9f40-e780951abc7d", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a23e7c6c-64dd-40b2-b518-5e0322ef3b11", "name": "Update tenant widget configuration", "request": { "name": "Update tenant widget configuration", "description": { "content": "Updates the widget configuration for a tenant. Creates a new versioned\nrecord. IdP credentials are stored in AWS Secrets Manager.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "widget-config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"taxonomy_libraries\": [\n \"\",\n \"\"\n ],\n \"branding\": {},\n \"approval_workflow\": {},\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "91cf0b43-c670-4c84-b00d-2de736f926ef", "name": "Configuration updated", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"taxonomy_libraries\": [\n \"\",\n \"\"\n ],\n \"branding\": {},\n \"approval_workflow\": {},\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"widget_id\": \"\",\n \"identity_providers\": [\n {\n \"provider\": \"entra_id\",\n \"enabled\": \"\",\n \"config\": {}\n },\n {\n \"provider\": \"eidas_eudi\",\n \"enabled\": \"\",\n \"config\": {}\n }\n ],\n \"taxonomy_libraries\": [\n \"\",\n \"\"\n ],\n \"branding\": {\n \"primary_color\": \"\",\n \"logo_url\": \"\",\n \"company_name\": \"\"\n },\n \"approval_workflow\": {\n \"require_principal_approval\": \"\",\n \"require_admin_approval\": \"\",\n \"auto_approve_trusted_idps\": \"\"\n },\n \"webhook_url\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67ad6964-2817-4246-917d-af7c7e7f587a", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"taxonomy_libraries\": [\n \"\",\n \"\"\n ],\n \"branding\": {},\n \"approval_workflow\": {},\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68269e4a-409d-4018-a89e-1ea4102ed711", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"taxonomy_libraries\": [\n \"\",\n \"\"\n ],\n \"branding\": {},\n \"approval_workflow\": {},\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "validate-idp", "description": "", "item": [ { "id": "8a3e48ba-3cc9-49dd-9b1b-182bc0547f01", "name": "Validate an IdP connection", "request": { "name": "Validate an IdP connection", "description": { "content": "Validates an Identity Provider configuration by attempting a client\ncredentials flow against the specified provider (Entra ID, Auth0, Okta, or eIDAS).\n\n**Alias support:** Accepts both `provider` (canonical) and `idpType` (legacy).\nIf both are present, `provider` takes precedence.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "widget-config", "validate-idp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"provider\": \"entra_id\",\n \"idpType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "02420a0c-855c-42e5-9113-875f39819954", "name": "Validation result", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "validate-idp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"provider\": \"entra_id\",\n \"idpType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"key_0\": {\n \"valid\": \"\",\n \"message\": \"\"\n },\n \"key_1\": {\n \"valid\": \"\",\n \"message\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30a6db32-77ec-4a3f-86b1-90f7abde2301", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "validate-idp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"provider\": \"entra_id\",\n \"idpType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed4fbc1-9f7e-4ec8-9eb7-096ae7739a7a", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "validate-idp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"config\": {},\n \"provider\": \"entra_id\",\n \"idpType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "versions", "description": "", "item": [ { "id": "86f8b6ce-0bbc-453e-94e9-6573cb6a0a48", "name": "List widget configuration versions", "request": { "name": "List widget configuration versions", "description": { "content": "Returns a paginated list of all configuration versions for the tenant,\nsorted by version number descending (newest first). Each entry contains\nversion metadata (not the full configuration body).\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "widget-config", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d480d26e-ae57-49de-bae6-a57ee6494d27", "name": "List of configuration versions", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"versions\": [\n {\n \"configVersion\": \"\",\n \"updatedAt\": \"\",\n \"createdAt\": \"\",\n \"status\": \"\",\n \"widgetId\": \"\",\n \"rollbackFrom\": \"\"\n },\n {\n \"configVersion\": \"\",\n \"updatedAt\": \"\",\n \"createdAt\": \"\",\n \"status\": \"\",\n \"widgetId\": \"\",\n \"rollbackFrom\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e51f6f7-4a4e-4b2d-80f9-9776148cf15a", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cb09570-5e73-474e-ad57-a3ee248b0d79", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "versions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "rollback", "description": "", "item": [ { "id": "ca401aac-66f3-48e3-966c-30be3f2dc371", "name": "Rollback widget configuration to a previous version", "request": { "name": "Rollback widget configuration to a previous version", "description": { "content": "Rolls back the widget configuration to a previous version by creating a\nnew version that is a copy of the target version. This preserves the\nfull version history for audit purposes — no versions are deleted.\n\nThe new version includes a `rollbackFrom` field indicating which version\nit was copied from.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "widget-config", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f87455f8-fc9c-4e38-aee0-4cf1f588b8ce", "name": "Rollback successful", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"version\": \"\",\n \"rollbackFrom\": \"\",\n \"widgetId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6192433e-9803-4047-ba61-dc308e3389a8", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "145e1246-3ce8-435d-84c8-50a2664cffda", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e01e88d1-e5d4-4859-b1fb-de7bcec0b9dc", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "widget-config", "rollback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "usage", "description": "", "item": [ { "id": "d82da5f4-c525-43db-8f2f-5333daa27a82", "name": "Get usage data for a tenant", "request": { "name": "Get usage data for a tenant", "description": { "content": "Returns usage data for the authenticated tenant's current or specified\nbilling period. Includes total units, per-endpoint breakdown, daily\nusage timeline, and per-API-key breakdown. The tenant path parameter\nmust match the authenticated caller.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Billing period in YYYY-MM format. Defaults to current month.", "type": "text/plain" }, "key": "period", "value": "3169-18" }, { "disabled": false, "description": { "content": " (This can only be one of daily,hourly)", "type": "text/plain" }, "key": "granularity", "value": "daily" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0a0f1a38-7cc5-4e25-823b-4e6a90bb5d33", "name": "Usage data for the billing period", "originalRequest": { "url": { "path": [ "tenants", ":id", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Billing period in YYYY-MM format. Defaults to current month.", "type": "text/plain" }, "key": "period", "value": "3169-18" }, { "disabled": false, "description": { "content": " (This can only be one of daily,hourly)", "type": "text/plain" }, "key": "granularity", "value": "daily" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"billing_period\": \"\",\n \"total_units\": \"\",\n \"endpoint_breakdown\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"daily_usage\": [\n {\n \"date\": \"\",\n \"units\": \"\"\n },\n {\n \"date\": \"\",\n \"units\": \"\"\n }\n ],\n \"api_key_breakdown\": [\n {\n \"api_key_id\": \"\",\n \"total_units\": \"\"\n },\n {\n \"api_key_id\": \"\",\n \"total_units\": \"\"\n }\n ],\n \"granularity\": \"hourly\",\n \"allowance\": {\n \"metered\": \"\",\n \"period\": \"\",\n \"limit\": \"\",\n \"used\": \"\",\n \"remaining\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23f1ad82-346b-44e7-a70a-a124a6ab109e", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Billing period in YYYY-MM format. Defaults to current month.", "type": "text/plain" }, "key": "period", "value": "3169-18" }, { "disabled": false, "description": { "content": " (This can only be one of daily,hourly)", "type": "text/plain" }, "key": "granularity", "value": "daily" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cbf1e39-a468-49de-9f57-f0ad3160e446", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Billing period in YYYY-MM format. Defaults to current month.", "type": "text/plain" }, "key": "period", "value": "3169-18" }, { "disabled": false, "description": { "content": " (This can only be one of daily,hourly)", "type": "text/plain" }, "key": "granularity", "value": "daily" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7478734e-5715-41d4-bb41-3c29f50cd103", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Billing period in YYYY-MM format. Defaults to current month.", "type": "text/plain" }, "key": "period", "value": "3169-18" }, { "disabled": false, "description": { "content": " (This can only be one of daily,hourly)", "type": "text/plain" }, "key": "granularity", "value": "daily" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "billing", "description": "", "item": [ { "id": "5bd18de9-4b72-4b07-aa7f-ec7de129baf3", "name": "Get billing status and invoice history", "request": { "name": "Get billing status and invoice history", "description": { "content": "Returns the side-effect-free local billing projection for the\nauthenticated tenant: the single approved metered offer, payment and\nentitlement state, recent invoices, and current-period usage. This GET\nnever creates a Stripe Customer Portal session. The tenant path\nparameter must match the authenticated caller.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ee8e6b81-41d6-4639-99c2-45a32548b472", "name": "Billing status and invoice history", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"catalog_version\": \"\",\n \"offer\": {\n \"id\": \"metered\",\n \"name\": \"\",\n \"currency\": \"eur\",\n \"unit_amount_minor\": 10,\n \"billing_block_units\": 1000\n },\n \"billing_status\": \"\",\n \"billing_plan\": \"metered\",\n \"billing_plan_name\": \"\",\n \"entitlement_status\": \"active\",\n \"activation_authority\": \"\",\n \"has_payment_method\": \"\",\n \"stripe_connected\": \"\",\n \"portal_available\": \"\",\n \"subscription\": {\n \"id\": \"\",\n \"status\": \"\",\n \"current_period_start\": \"\",\n \"current_period_end\": \"\",\n \"cancel_at_period_end\": \"\"\n },\n \"invoices\": [\n {\n \"id\": \"\",\n \"number\": \"\",\n \"billing_period\": \"\",\n \"status\": \"\",\n \"amount_due\": \"\",\n \"amount_paid\": \"\",\n \"currency\": \"\",\n \"created_at\": \"\",\n \"paid_at\": \"\",\n \"hosted_invoice_url\": \"\",\n \"pdf_url\": \"\"\n },\n {\n \"id\": \"\",\n \"number\": \"\",\n \"billing_period\": \"\",\n \"status\": \"\",\n \"amount_due\": \"\",\n \"amount_paid\": \"\",\n \"currency\": \"\",\n \"created_at\": \"\",\n \"paid_at\": \"\",\n \"hosted_invoice_url\": \"\",\n \"pdf_url\": \"\"\n }\n ],\n \"current_period\": {\n \"billing_period\": \"\",\n \"total_units\": \"\",\n \"endpoint_breakdown\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"estimated_amount_minor\": \"\",\n \"currency\": \"eur\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2d19763-2e8c-44c3-8d6b-4f88351f09d0", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7fcb9ce-c6e7-4a2d-8789-70aeee806772", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50df7a3d-edfb-4419-9483-361b95185e2b", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "424fc04b-ece2-47d3-a4bb-b1314fb902cb", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "setup-intent", "description": "", "item": [ { "id": "96d2e9fc-5074-4ecd-86fc-eba6c5b32794", "name": "Create a Stripe SetupIntent for card collection", "request": { "name": "Create a Stripe SetupIntent for card collection", "description": { "content": "Starts product-owned payment-method collection for the tenant when the\nrollout flags are enabled. A successful SetupIntent never activates\npaid access. Returns a client secret for Stripe.js / Stripe Elements.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "billing", "setup-intent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "63fa92fa-9964-476a-ac8a-8e30f536523c", "name": "SetupIntent created", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "setup-intent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"client_secret\": \"\",\n \"status\": \"pending\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faf09fc6-c75b-47f4-a5c5-959c95d52d73", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "setup-intent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6923c7af-8f02-43c6-ac24-fe3fbf8bdd92", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "setup-intent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00a8241e-6207-41d5-98d8-2326896f19ec", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "setup-intent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d1f2a4a-dde4-4373-9470-0ca3398e4ccd", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "setup-intent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b67f14b8-a6b4-4511-ab93-c7ef8215f8fa", "name": "Stripe API error", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "setup-intent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "subscription", "description": "", "item": [ { "id": "0f071b39-25d9-4c48-a584-d75ac896b8cd", "name": "Start the single Mandaitor metered billing offer", "request": { "name": "Start the single Mandaitor metered billing offer", "description": { "content": "Starts or resumes the single EUR 0.10 per 1,000 unit Mandaitor offer\nwhen rollout flags are enabled. The handler records a pending attempt;\nit never grants paid access. Activation is projected only after an\neligible owned subscription and a paid or legitimately zero initial\ninvoice. If payment details are missing, a SetupIntent client secret is\nreturned without activating service.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"metered\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "aeabee94-6c56-4ed7-8166-f0d631852c10", "name": "Subscription created or updated", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"metered\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"plan\": \"metered\",\n \"plan_name\": \"\",\n \"status\": \"pending\",\n \"requires_payment\": \"\",\n \"requires_action\": \"\",\n \"subscription_id\": \"\",\n \"client_secret\": \"\",\n \"payment_client_secret\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07686940-0ade-4300-8ad2-b556ce609a85", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"metered\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ab3eaa4-3222-4c7e-9ec8-b78bc59800aa", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"metered\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40a1c3df-ee69-428a-b6f9-3b64c0d09dc6", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"metered\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2c6e01-b3a7-4e6e-9ba7-69b9b3470795", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"metered\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58fcfc5b-1be5-4b90-a292-7dbf29332f37", "name": "Stripe API error", "originalRequest": { "url": { "path": [ "tenants", ":id", "billing", "subscription" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"plan\": \"metered\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "playground", "description": "", "item": [ { "name": "verify", "description": "", "item": [ { "id": "0c524c4c-92c8-4623-9298-628f11eccce4", "name": "Playground dry-run verify (Cognito JWT, no raw API key)", "request": { "name": "Playground dry-run verify (Cognito JWT, no raw API key)", "description": { "content": "Dashboard-only dry-run verify endpoint. Authenticated via Cognito JWT\n(dashboard session). The caller selects an API key by its key_id from\na dropdown; the handler loads the key's metadata (scopes, status) and\nsimulates the verify flow as if the request had come through that key.\nNo raw API key is ever needed. Metering is intentionally skipped.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "playground", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"request_pom\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6e5a3572-ad45-483d-a9a0-ff3fdaa95444", "name": "Playground verification result", "originalRequest": { "url": { "path": [ "tenants", ":id", "playground", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"request_pom\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"decision\": \"DENY\",\n \"event_id\": \"\",\n \"_playground\": {\n \"simulated_key\": {\n \"key_id\": \"\",\n \"key_name\": \"\",\n \"last_four\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"has_verify_scope\": \"\"\n },\n \"dry_run\": \"\"\n },\n \"mandate_id\": \"\",\n \"reason_codes\": [\n \"\",\n \"\"\n ],\n \"constraints_remaining\": {},\n \"proof_of_mandate\": {},\n \"proof_token\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a58cfb63-1aab-4893-aaca-bff2c00345a2", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "playground", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"request_pom\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddd62a03-b3b1-40fd-8f07-0d1315553063", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "playground", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"request_pom\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa9ba9a0-de7c-424c-b8fa-1d07940244cb", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "playground", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"request_pom\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "356d7975-c06b-4920-9274-d595c59cfbcf", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "playground", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"request_pom\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a165a9bd-5356-4996-b621-407c2f96e5eb", "name": "Internal server error", "originalRequest": { "url": { "path": [ "tenants", ":id", "playground", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_id\": \"\",\n \"action\": \"\",\n \"resource\": \"\",\n \"delegate_subject_id\": \"\",\n \"agent_id\": \"\",\n \"context\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"request_pom\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "onboarding-status", "description": "", "item": [ { "id": "29932ce1-31e1-4e3d-9d29-781cbbc31939", "name": "Get dashboard onboarding status", "request": { "name": "Get dashboard onboarding status", "description": { "content": "Returns the current dashboard onboarding tour status for the\nauthenticated tenant. Used by the guided tour overlay to determine\nwhether to show the onboarding flow.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a8ecb663-1be7-451b-ba3f-78912f5bdc1d", "name": "Current onboarding status", "originalRequest": { "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"onboarding\": {\n \"completed\": \"\",\n \"skipped\": \"\",\n \"completed_steps\": [\n \"\",\n \"\"\n ],\n \"current_step\": \"\",\n \"completed_at\": \"\",\n \"skipped_at\": \"\",\n \"started_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "119d0150-d05f-4776-8368-b56b21690cd1", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "021aa473-4905-4709-9546-cbbe87599bca", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21714fd3-ef04-4f83-a79e-c287c6464d13", "name": "Update dashboard onboarding progress", "request": { "name": "Update dashboard onboarding progress", "description": { "content": "Updates the dashboard onboarding tour progress for the authenticated\ntenant. Supports marking steps as completed, advancing the current\nstep, and completing or skipping the entire tour.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"completed\": \"\",\n \"skipped\": \"\",\n \"completed_steps\": [\n \"\",\n \"\"\n ],\n \"current_step\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7ebf56ec-c73d-4ebf-aa82-a721e93760f2", "name": "Updated onboarding status", "originalRequest": { "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"completed\": \"\",\n \"skipped\": \"\",\n \"completed_steps\": [\n \"\",\n \"\"\n ],\n \"current_step\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"onboarding\": {\n \"completed\": \"\",\n \"skipped\": \"\",\n \"completed_steps\": [\n \"\",\n \"\"\n ],\n \"current_step\": \"\",\n \"completed_at\": \"\",\n \"skipped_at\": \"\",\n \"started_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c40eed50-3561-439f-8327-cc48d5f8ce13", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"completed\": \"\",\n \"skipped\": \"\",\n \"completed_steps\": [\n \"\",\n \"\"\n ],\n \"current_step\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47ace27e-0f98-40e8-97ae-0aff7e07a120", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"completed\": \"\",\n \"skipped\": \"\",\n \"completed_steps\": [\n \"\",\n \"\"\n ],\n \"current_step\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a774239-16da-4e47-b156-9b722219c86c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "onboarding-status" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Workspace onboarding context. Defaults to product_workspace for backward compatibility. (This can only be one of product_workspace,partner_project_workspace)", "type": "text/plain" }, "key": "workspace", "value": "product_workspace" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"completed\": \"\",\n \"skipped\": \"\",\n \"completed_steps\": [\n \"\",\n \"\"\n ],\n \"current_step\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "connectors", "description": "", "item": [ { "id": "9e806fd0-b493-402c-96a8-a62288b4250e", "name": "List configured connector instances", "request": { "name": "List configured connector instances", "description": {}, "url": { "path": [ "tenants", ":id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0ed9218a-6174-45c7-9c46-454749ed9aa9", "name": "Configured connector instances (secret fields omitted)", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connectors\": [\n {\n \"connector_id\": \"\",\n \"tenant_id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"sandbox_id\": \"\",\n \"environment\": \"i0ip22u3skg4kefzw-xaq6ts4s\",\n \"credentials_rotated_at\": \"\",\n \"credentials_rotated_by\": \"\",\n \"status\": \"unverified\",\n \"last_test_at\": \"\",\n \"last_test_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"connector_id\": \"\",\n \"tenant_id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\"\n },\n \"sandbox_id\": \"\",\n \"environment\": \"hszjilm6eecn5m700escds7g0j\",\n \"credentials_rotated_at\": \"\",\n \"credentials_rotated_by\": \"\",\n \"status\": \"connected\",\n \"last_test_at\": \"\",\n \"last_test_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "094b7526-3994-4361-b013-4ade4eebf5af", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b43fd4ac-9190-4272-b757-7a0ee5a2f353", "name": "Configure a new connector instance", "request": { "name": "Configure a new connector instance", "description": { "content": "Validates the configuration against the catalog entry, rejects\ninstance URLs the SSRF guard would block, KMS-encrypts secret fields,\nand stores the instance with status `unverified`. Secret fields are\nwrite-only — they are never returned by any connector route.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\"\n },\n \"environment\": \"c5-6eoeulk6ixa9wq-2qzar4h\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2bbe57d9-063c-4778-91a1-92cc86abca62", "name": "Connector instance created", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\"\n },\n \"environment\": \"c5-6eoeulk6ixa9wq-2qzar4h\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connector_id\": \"\",\n \"tenant_id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sandbox_id\": \"\",\n \"environment\": \"krjpni5c69jz0\",\n \"credentials_rotated_at\": \"\",\n \"credentials_rotated_by\": \"\",\n \"status\": \"connected\",\n \"last_test_at\": \"\",\n \"last_test_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4aad6db1-63fa-483e-9c83-23bbc149941d", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\"\n },\n \"environment\": \"c5-6eoeulk6ixa9wq-2qzar4h\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11e55492-4065-43d0-8f10-e4ad1cdb33c5", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\"\n },\n \"environment\": \"c5-6eoeulk6ixa9wq-2qzar4h\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "sandbox", "description": "", "item": [ { "id": "c20a9e14-c2aa-4591-ac63-82720f8e9920", "name": "Provision a hosted demo sandbox and configure a connector for it", "request": { "name": "Provision a hosted demo sandbox and configure a connector for it", "description": { "content": "Creates a Mandaitor-hosted emulation of the requested enterprise system\n(ServiceNow Table API or SAP S/4HANA OData), seeds it with the demo\nrecords, and configures a connector instance pointing at it — so the\nfull governed loop can be exercised without a customer system.\n\nThe result is an ordinary connector: same storage, same KMS-encrypted\ncredential, same test-connection probe, same governed tool calls. Only\nthe target differs, and `sandbox_id` marks it as sandbox-backed.\nSandboxes expire after 30 days and are deleted with their connector.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "connectors", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"sap-s4hana\",\n \"name\": \"\",\n \"environment\": \"cql9ccadz684l\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2cac40e3-c0f9-435c-b3f1-cb032e9287bc", "name": "Sandbox provisioned and connector configured.\n\nA sandbox's credential is never disclosed: only Mandaitor's\nexecutor writes to it, through the execution API\n(`POST /executions`). A ServiceNow sandbox provisioned before\nexecution roadmap E2.11 showed its credential once; replacing the\nconnector's credential\n(`PUT /tenants/{id}/connectors/{connectorId}/credentials`) retires\nthe one shown.", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"sap-s4hana\",\n \"name\": \"\",\n \"environment\": \"cql9ccadz684l\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connector_id\": \"\",\n \"tenant_id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"sandbox_id\": \"\",\n \"environment\": \"r8vumxqtj77dop12fvud322-h-636hk\",\n \"credentials_rotated_at\": \"\",\n \"credentials_rotated_by\": \"\",\n \"status\": \"connected\",\n \"last_test_at\": \"\",\n \"last_test_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0495e9ef-57bb-4550-b1d3-8aa9d8120260", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"sap-s4hana\",\n \"name\": \"\",\n \"environment\": \"cql9ccadz684l\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c5f0677-fb71-42ed-86ee-10486e872323", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"sap-s4hana\",\n \"name\": \"\",\n \"environment\": \"cql9ccadz684l\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{connectorId}", "description": "", "item": [ { "name": "reset", "description": "", "item": [ { "id": "30ef222b-3b1c-4827-bf80-1551866b96ab", "name": "Reset a sandbox-backed connector's data to its seeded state", "request": { "name": "Reset a sandbox-backed connector's data to its seeded state", "description": { "content": "Restores the hosted sandbox behind this connector to the records it was\nprovisioned with, so a demo can be re-run from a clean slate. Rejected\nfor connectors that point at a real system.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "connectorId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5410223d-c222-4a30-940e-722c2d2a4834", "name": "Sandbox data restored", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"connector\": {\n \"connector_id\": \"\",\n \"tenant_id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\"\n },\n \"sandbox_id\": \"\",\n \"environment\": \"qes36x\",\n \"credentials_rotated_at\": \"\",\n \"credentials_rotated_by\": \"\",\n \"status\": \"connected\",\n \"last_test_at\": \"\",\n \"last_test_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4f9e7e2-4184-42b6-8eb5-d5522e078f7b", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "007560ec-3392-41c7-acd0-24f3b5acddd2", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "3edd278a-04b1-464c-8908-7bd4c6ec3a82", "name": "Remove a connector instance", "request": { "name": "Remove a connector instance", "description": {}, "url": { "path": [ "tenants", ":id", "connectors", ":connectorId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "connectorId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "42ac50b3-2703-44cc-b571-4a0ecfda1674", "name": "Connector instance removed", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4a661607-e909-463d-81ee-a81317a78ae8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffb746ae-d703-4674-8a63-261f9992ee87", "name": "`CONNECTOR_IN_USE`: a tool is enabled on this connector; `tools`\nlists them. Disable them first.", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "test", "description": "", "item": [ { "id": "eed2a216-8d1f-46df-b611-31e3408d785a", "name": "Run a live connection test", "request": { "name": "Run a live connection test", "description": { "content": "Has the executor, the one function that decrypts a credential, make\none read-only probe against the configured system with the stored\ncredential (for ServiceNow: an authenticated Table API read of a\nsingle requested item). Updates the instance's `status`,\n`last_test_at`, and `last_test_message` with the outcome, and nothing\nelse.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "connectorId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1bcd4434-99bc-4104-bea9-9dd90fe97a04", "name": "Test outcome (also persisted on the instance)", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connector\": {\n \"connector_id\": \"\",\n \"tenant_id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sandbox_id\": \"\",\n \"environment\": \"c5\",\n \"credentials_rotated_at\": \"\",\n \"credentials_rotated_by\": \"\",\n \"status\": \"connected\",\n \"last_test_at\": \"\",\n \"last_test_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"test\": {\n \"ok\": \"\",\n \"message\": \"\",\n \"http_status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ba6c5e0-33bd-4d0e-b453-acc74b990346", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "credentials", "description": "", "item": [ { "id": "5a7ae15d-4eac-4984-981d-73dc23070b19", "name": "Replace a connector's credential, probed first", "request": { "name": "Replace a connector's credential, probed first", "description": { "content": "Replaces the connector's credential in place (execution roadmap\nE2.10). The executor probes the system with the new credential first;\nit is stored only if the system accepts it, and only if the stored\ncredential is still the one read before the probe. The connector keeps\nits id, so the tools enabled on it, approvals waiting on it and\nexecutions not yet dispatched carry on, with the new credential.\nRequires `tenant:write`.\n\nWhere the system allows two credentials at once, as an API key often\ndoes, add the new one there, replace it here, then remove the old one\nthere: nothing fails in between. Where changing it at the system ends\nthe old one at once, as a password change does, executions dispatched\nbetween that change and this call fail.\n\nA sandbox's credential is minted by Mandaitor and never shown: send no\nbody. The sandbox accepts the new secret beside the old one while it\nis probed, and only the new one once it is stored, so a ServiceNow\nsandbox credential shown at provisioning stops working.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "connectorId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4327ec35-d701-48d0-a6e9-7b130bf6e192", "name": "The new credential is stored; the probe that tried it", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connector\": {\n \"connector_id\": \"\",\n \"tenant_id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"config\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"sandbox_id\": \"\",\n \"environment\": \"c5\",\n \"credentials_rotated_at\": \"\",\n \"credentials_rotated_by\": \"\",\n \"status\": \"connected\",\n \"last_test_at\": \"\",\n \"last_test_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"test\": {\n \"ok\": \"\",\n \"message\": \"\",\n \"http_status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dcb373d-6ea9-489f-9cef-365209577013", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e09152d-5d7d-47fc-83f9-d8bba6d4f81b", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad753dd3-e937-4be3-9ebd-95c78874df04", "name": "Resource not found", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf3353d1-9fc8-4bbf-9e5c-2f02c2953dd5", "name": "`CREDENTIAL_CONFLICT`: the credential was replaced by someone else\nmeanwhile, so this one was not stored.", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539baee7-bb59-415a-838a-4d3045877e77", "name": "`CREDENTIAL_REJECTED`: the system did not accept the new\ncredential, so nothing was changed. `test` is the probe's outcome.", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"test\": {\n \"ok\": \"\",\n \"message\": \"\",\n \"http_status\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "310e75c7-ff4c-4c04-b87f-fcc5e73ac2c7", "name": "`ROTATION_INCOMPLETE`, for a sandbox only: the new credential is\nstored and works, but the sandbox still accepts the old one too.\nReplace it again to retire the old one.", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cd4f1d0-4f09-4dbe-bcc9-88e64638f351", "name": "`PROBE_UNAVAILABLE`: the new credential could not be tried\nagainst the system, so nothing was changed. Try again.", "originalRequest": { "url": { "path": [ "tenants", ":id", "connectors", ":connectorId", "credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "connectorId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"credentials\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "tools", "description": "", "item": [ { "id": "142d5837-613b-4898-b1ea-f7f0ef9b5750", "name": "Get the tenant's execution policy", "request": { "name": "Get the tenant's execution policy", "description": { "content": "Which tool version runs on which of the tenant's connectors, in each\nof its environments. `version` rises by one on every change, in any\nenvironment; an approval's digest records it, so a change to the\npolicy forces a fresh approval, in every environment. Before the first\nenablement, `policy_id` is null and `version` is 0.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c36f909d-2ad3-424c-80f0-2cc7ae172b23", "name": "The execution policy", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policy_id\": \"\",\n \"version\": \"\",\n \"tools\": [\n {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"environment\": \"hyasyy1lh\",\n \"connector_id\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\"\n },\n {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"environment\": \"yrhp8zuqner\",\n \"connector_id\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\"\n }\n ],\n \"updated_at\": \"\",\n \"updated_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "057d9f37-71ea-4503-96f9-d030179b74b3", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{toolId}", "description": "", "item": [ { "id": "cb1c9f37-3a9b-47ee-8647-0801cdb815ae", "name": "Enable a tool version on a connector, in one environment", "request": { "name": "Enable a tool version on a connector, in one environment", "description": { "content": "Enables one version of a tool in one environment, on one of the\ntenant's connectors, replacing any version enabled there before, and\nraises the policy version. Requires `tenant:write`. The tool must be\navailable, and the connector must exist, be of the tool's\n`connector_type` and be in the environment named, `default` when none\nis. An agent's executions use the tool as enabled in the agent's\nenvironment.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "toolId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"connector_id\": \"con_f0CpzfK3x2AElmWHz4VD0el0PI0vFvl3YBpLL7ZtDuu484hl\",\n \"environment\": \"ohh-sv2-4-w16hocgbhvjqu7dq00v\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "85261c59-c5a0-4cae-9caf-50e5e13702e8", "name": "Enabled; the policy's new version", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"connector_id\": \"con_f0CpzfK3x2AElmWHz4VD0el0PI0vFvl3YBpLL7ZtDuu484hl\",\n \"environment\": \"ohh-sv2-4-w16hocgbhvjqu7dq00v\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policy_id\": \"\",\n \"version\": \"\",\n \"tool\": {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"environment\": \"ax-u7ndo18uv7jdfs1yo8p0wu2736tzf\",\n \"connector_id\": \"\",\n \"enabled_at\": \"\",\n \"enabled_by\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b76845b-cc44-4778-9b9b-1f437a33f8cd", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"connector_id\": \"con_f0CpzfK3x2AElmWHz4VD0el0PI0vFvl3YBpLL7ZtDuu484hl\",\n \"environment\": \"ohh-sv2-4-w16hocgbhvjqu7dq00v\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99f30bcd-2b37-4a8a-b3ca-3516cd0a60a6", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"connector_id\": \"con_f0CpzfK3x2AElmWHz4VD0el0PI0vFvl3YBpLL7ZtDuu484hl\",\n \"environment\": \"ohh-sv2-4-w16hocgbhvjqu7dq00v\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b734eb7e-43a8-4346-ac44-057647967a55", "name": "`TOOL_NOT_FOUND`, `TOOL_VERSION_NOT_FOUND` or `CONNECTOR_NOT_FOUND`", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"connector_id\": \"con_f0CpzfK3x2AElmWHz4VD0el0PI0vFvl3YBpLL7ZtDuu484hl\",\n \"environment\": \"ohh-sv2-4-w16hocgbhvjqu7dq00v\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9658ea27-d752-4cfe-bb1c-d6c5115f72a8", "name": "`TOOL_UNAVAILABLE` (no loaded taxonomy defines the business action;\n`reason` says which), `CONNECTOR_TYPE_MISMATCH`,\n`CONNECTOR_ENVIRONMENT_MISMATCH` (the connector is in another\nenvironment), or `POLICY_CONFLICT` (the policy changed\nconcurrently: read it again and retry)", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"connector_id\": \"con_f0CpzfK3x2AElmWHz4VD0el0PI0vFvl3YBpLL7ZtDuu484hl\",\n \"environment\": \"ohh-sv2-4-w16hocgbhvjqu7dq00v\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f085cf32-e611-4ef8-a673-6b985f796d8c", "name": "Disable a tool in one environment", "request": { "name": "Disable a tool in one environment", "description": { "content": "Disables the tool in one environment and raises the policy version.\nRequires `tenant:write`.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The environment to disable it in, `default` when not given", "type": "text/plain" }, "key": "environment", "value": "tenxfe-qeapzx" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "toolId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f18b4974-5461-40e3-8582-da317dc65b6e", "name": "Disabled", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The environment to disable it in, `default` when not given", "type": "text/plain" }, "key": "environment", "value": "tenxfe-qeapzx" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6a24955-1936-427d-ada7-f8c340543b93", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The environment to disable it in, `default` when not given", "type": "text/plain" }, "key": "environment", "value": "tenxfe-qeapzx" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a310b9-df93-49f7-82cf-1b5f134b7228", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The environment to disable it in, `default` when not given", "type": "text/plain" }, "key": "environment", "value": "tenxfe-qeapzx" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfde0d3f-7f81-4883-8307-d29034c47b3d", "name": "`TOOL_NOT_FOUND`, or `TOOL_NOT_ENABLED` for a tool not enabled in that environment", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The environment to disable it in, `default` when not given", "type": "text/plain" }, "key": "environment", "value": "tenxfe-qeapzx" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b75fe34-6a76-4165-a5eb-fafbcb5dc4e9", "name": "`POLICY_CONFLICT`: the policy changed concurrently", "originalRequest": { "url": { "path": [ "tenants", ":id", "tools", ":toolId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The environment to disable it in, `default` when not given", "type": "text/plain" }, "key": "environment", "value": "tenxfe-qeapzx" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "toolId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "executions", "description": "", "item": [ { "id": "4e639f39-eee2-441d-9ce4-d5bcd0e70a52", "name": "List the tenant's executions", "request": { "name": "List the tenant's executions", "description": { "content": "The tenant's executions, newest first, for a person of the tenant:\nthe dashboard's Executions page (roadmap E1.11). Each is the\nexecution as its agent reads it, and what it rested on: the agent,\nthe record and the facts read from it, the approval it needed, and\nwhat the write did.\n\nRequires `tenant:read` in the caller's own tenant, which a dashboard\nsession has and an API key never does. An agent reads its own\nexecutions with `GET /executions/{id}` and its session token.\n\n`state` keeps the executions in that state. Mandaitor filters after\nit reads, so a page can hold fewer than `limit`, even none, with a\n`next_cursor` still to follow; the list ends when there is none.\n\nAn execution waiting for an approval that has expired is listed as\nstored until it is read or swept, within a minute: its\n`approval.expires_at` is then in the past.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of AWAITING_APPROVAL,AUTHORIZED_NOT_EXECUTED,EXECUTING,UNKNOWN,SUCCEEDED,FAILED,DENIED)", "type": "text/plain" }, "key": "state", "value": "DENIED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "The `next_cursor` of the page before. Another is refused.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "166a7207-1c2a-4394-b5b1-1155eb185436", "name": "A page of the tenant's executions, newest first", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of AWAITING_APPROVAL,AUTHORIZED_NOT_EXECUTED,EXECUTING,UNKNOWN,SUCCEEDED,FAILED,DENIED)", "type": "text/plain" }, "key": "state", "value": "DENIED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "The `next_cursor` of the page before. Another is refused.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"agent\": {\n \"agent_id\": \"\",\n \"did\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:c8H-FTB6TXHOhkAZNr_rfwwJ5TtjMviGq-XO6i8C6PE\",\n \"expires_at\": \"\",\n \"approved_at\": \"\",\n \"approver\": \"\",\n \"require_mfa\": \"\",\n \"rules\": [\n \"AMOUNT_ABOVE_THRESHOLD\",\n \"ACTION_REQUIRES_APPROVAL\"\n ],\n \"approved_by\": \"\"\n },\n \"arguments\": {},\n \"authorization\": {\n \"event_id\": \"\",\n \"mandate_id\": \"\",\n \"pom_digest\": \"sha-256:tcRdD1aJp-vhqZi_CuU-CeSXwvu6SWmXk2xTGVlRel7\"\n },\n \"completed_at\": \"\",\n \"connector_id\": \"\",\n \"contract\": \"mandaitor.execution/v1\",\n \"created_at\": \"\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\",\n \"decided_at\": \"\"\n },\n \"dispatched_at\": \"\",\n \"execution_id\": \"exe_7XYOPHAZG57LHSBO05R2LNEFHC\",\n \"facts\": {},\n \"outcome\": {\n \"version_after\": \"\",\n \"transaction_ref\": \"\",\n \"target_status\": \"\",\n \"reason\": \"\",\n \"write_acknowledged\": \"\"\n },\n \"purpose\": \"\",\n \"receipt\": \"\",\n \"reconciliation\": {\n \"attempts\": \"\",\n \"last_attempt_at\": \"\",\n \"last_reason\": \"\",\n \"next_at\": \"\"\n },\n \"request_digest\": \"sha-256:Q3nC8Iz4WSti3z0w8achAib1FSc_AKn1u3i4q8tvE9h\",\n \"resolution\": {\n \"resolved_by\": \"\",\n \"resolved_at\": \"\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n },\n \"result\": {},\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"state\": \"EXECUTING\",\n \"state_reason\": \"AGENT_NOT_ACTIVE\",\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\",\n \"version_kind\": \"\"\n },\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"updated_at\": \"\",\n \"reservation\": {\n \"reservation_id\": \"\",\n \"mandate_id\": \"\",\n \"status\": \"HELD\",\n \"held_at\": \"\",\n \"counters\": [\n {\n \"kind\": \"count\",\n \"window\": \"PT1H\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"limit\": \"\",\n \"delta\": \"\"\n },\n {\n \"kind\": \"count\",\n \"window\": \"P1D\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"limit\": \"\",\n \"delta\": \"\"\n }\n ],\n \"settled_at\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n },\n {\n \"agent\": {\n \"agent_id\": \"\",\n \"did\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:wEstX4PquU7r6g-vRC--oTJvL-ki48F6rzCAXJsmi4v\",\n \"expires_at\": \"\",\n \"approved_at\": \"\",\n \"approver\": \"\",\n \"require_mfa\": \"\",\n \"rules\": [\n \"REQUIRE_MFA\",\n \"ACTION_REQUIRES_APPROVAL\"\n ],\n \"approved_by\": \"\"\n },\n \"arguments\": {},\n \"authorization\": {\n \"event_id\": \"\",\n \"mandate_id\": \"\",\n \"pom_digest\": \"sha-256:TwE1JR4uw7p1tf_1xRqxUAxaCC2HS5o0Z29Q3Wk0rth\"\n },\n \"completed_at\": \"\",\n \"connector_id\": \"\",\n \"contract\": \"mandaitor.execution/v1\",\n \"created_at\": \"\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"ALLOW\",\n \"reason\": \"\",\n \"mandate_id\": \"\",\n \"decided_at\": \"\"\n },\n \"dispatched_at\": \"\",\n \"execution_id\": \"exe_I5NC39VZOCRFLMD0RSBBPEIAN1\",\n \"facts\": {},\n \"outcome\": {\n \"version_after\": \"\",\n \"transaction_ref\": \"\",\n \"target_status\": \"\",\n \"reason\": \"\",\n \"write_acknowledged\": \"\"\n },\n \"purpose\": \"\",\n \"receipt\": \"\",\n \"reconciliation\": {\n \"attempts\": \"\",\n \"last_attempt_at\": \"\",\n \"last_reason\": \"\",\n \"next_at\": \"\"\n },\n \"request_digest\": \"sha-256:jRmhIkTnTEfQZlX1aiqylFBgMDuV537MRAFOEvmrizH\",\n \"resolution\": {\n \"resolved_by\": \"\",\n \"resolved_at\": \"\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n },\n \"result\": {},\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"state\": \"FAILED\",\n \"state_reason\": \"DENIED_BY_MANDATE\",\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\",\n \"version_kind\": \"\"\n },\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"updated_at\": \"\",\n \"reservation\": {\n \"reservation_id\": \"\",\n \"mandate_id\": \"\",\n \"status\": \"HELD\",\n \"held_at\": \"\",\n \"counters\": [\n {\n \"kind\": \"count\",\n \"window\": \"P1W\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"limit\": \"\",\n \"delta\": \"\"\n },\n {\n \"kind\": \"count\",\n \"window\": \"P1W\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"limit\": \"\",\n \"delta\": \"\"\n }\n ],\n \"settled_at\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8abc1d51-0a95-41a4-bd4c-ad7316132414", "name": "`INVALID_REQUEST`: an unknown parameter, a `state` that is not\none, or a `limit` outside 1 to 50; `errors` lists each problem.\n`INVALID_CURSOR`: a cursor this list did not give out.", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of AWAITING_APPROVAL,AUTHORIZED_NOT_EXECUTED,EXECUTING,UNKNOWN,SUCCEEDED,FAILED,DENIED)", "type": "text/plain" }, "key": "state", "value": "DENIED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "The `next_cursor` of the page before. Another is refused.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "845e5ca7-b597-410a-bc85-da54de62c83c", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of AWAITING_APPROVAL,AUTHORIZED_NOT_EXECUTED,EXECUTING,UNKNOWN,SUCCEEDED,FAILED,DENIED)", "type": "text/plain" }, "key": "state", "value": "DENIED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "The `next_cursor` of the page before. Another is refused.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3acb2f4b-145e-4939-98a3-b78f5ef8f895", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of AWAITING_APPROVAL,AUTHORIZED_NOT_EXECUTED,EXECUTING,UNKNOWN,SUCCEEDED,FAILED,DENIED)", "type": "text/plain" }, "key": "state", "value": "DENIED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "The `next_cursor` of the page before. Another is refused.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{executionId}", "description": "", "item": [ { "id": "ce261816-a18f-4439-888d-6de3805a5033", "name": "Read one of the tenant's executions", "request": { "name": "Read one of the tenant's executions", "description": { "content": "One execution, for a person of the tenant, authorised as the list\nis. Another tenant's execution, or an id that does not exist, is\n404. An execution whose approval expired undecided is answered, and\nrecorded, as `DENIED` with `APPROVAL_EXPIRED`, as it is when its\nagent reads it.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "executions", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d84dbe89-c9fa-460e-9d67-739ec45c3b77", "name": "The execution", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent\": {\n \"agent_id\": \"\",\n \"did\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:4zgGKDcorLedXBy2pDOB47Hb7XwBrWlui2w5lbZNclT\",\n \"expires_at\": \"\",\n \"approved_at\": \"\",\n \"approver\": \"\",\n \"require_mfa\": \"\",\n \"rules\": [\n \"REQUIRE_MFA\",\n \"ACTION_REQUIRES_APPROVAL\"\n ],\n \"approved_by\": \"\"\n },\n \"arguments\": {},\n \"authorization\": {\n \"event_id\": \"\",\n \"mandate_id\": \"\",\n \"pom_digest\": \"sha-256:hL_VAEKSqQPXW_PWtZvUWa4uh2EkZ46Wvk1f8TlA_1r\"\n },\n \"completed_at\": \"\",\n \"connector_id\": \"\",\n \"contract\": \"mandaitor.execution/v1\",\n \"created_at\": \"\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"ALLOW\",\n \"reason\": \"\",\n \"mandate_id\": \"\",\n \"decided_at\": \"\"\n },\n \"dispatched_at\": \"\",\n \"execution_id\": \"exe_NZ3Q8LF0TIX5NGMZOPGD1TNKZW\",\n \"facts\": {},\n \"outcome\": {\n \"version_after\": \"\",\n \"transaction_ref\": \"\",\n \"target_status\": \"\",\n \"reason\": \"\",\n \"write_acknowledged\": \"\"\n },\n \"purpose\": \"\",\n \"receipt\": \"\",\n \"reconciliation\": {\n \"attempts\": \"\",\n \"last_attempt_at\": \"\",\n \"last_reason\": \"\",\n \"next_at\": \"\"\n },\n \"request_digest\": \"sha-256:20I3ar-ME6LqLH9JdafsGVdC0SfAntYzUVlI0sdnyeu\",\n \"resolution\": {\n \"resolved_by\": \"\",\n \"resolved_at\": \"\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n },\n \"result\": {},\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"RECORD_NOT_FOUND\",\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\",\n \"version_kind\": \"\"\n },\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"updated_at\": \"\",\n \"reservation\": {\n \"reservation_id\": \"\",\n \"mandate_id\": \"\",\n \"status\": \"RELEASED\",\n \"held_at\": \"\",\n \"counters\": [\n {\n \"kind\": \"total\",\n \"window\": \"P1W\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"limit\": \"\",\n \"delta\": \"\"\n },\n {\n \"kind\": \"count\",\n \"window\": \"P1D\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"limit\": \"\",\n \"delta\": \"\"\n }\n ],\n \"settled_at\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "369bb5b3-33d5-4ada-a1b9-3454651aeb0a", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d08b4a01-f386-48cc-9587-68213ae0e8e5", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "629ad3c7-fc7f-469a-bd28-5197369dcbae", "name": "`EXECUTION_NOT_FOUND`", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "resolution", "description": "", "item": [ { "id": "63cbd365-0bc4-424b-9bd1-b1629efb204b", "name": "Resolve an UNKNOWN execution", "request": { "name": "Resolve an UNKNOWN execution", "description": { "content": "A person of the tenant records the outcome of an `UNKNOWN`\nexecution that no read-back could establish (roadmap E2.1), after\nlooking at the target system. Requires `tenant:write` in the\ncaller's own tenant, and a person's session: an API key or an\nagent is refused with 403 `NOT_A_PERSON`.\n\n**The target's own record comes first.** Mandaitor reads the record\nback once more before it records anything. If that read-back finds\nthe write applied, the execution is `SUCCEEDED`; if it proves the\nwrite absent (and the target never acknowledged it), `FAILED`; either\nway with `RESOLVED_BY_READ_BACK` and a receipt, whatever you sent.\nWhen that differs from your `outcome`, the answer is 409\n`OUTCOME_CONTRADICTED`, with the execution as it now is.\n\n**Otherwise your outcome stands**, as `SUCCEEDED` or `FAILED` with\n`RESOLVED_BY_OPERATOR`, your evidence in `resolution`, and no\nreceipt: Mandaitor signs only what it read back. Your resolution\nand evidence go on the audit trail. A `FAILED` execution tells its\nagent it may ask again, and a new request is a new write.\n", "type": "text/plain" }, "url": { "path": [ "tenants", ":id", "executions", ":executionId", "resolution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"outcome\": \"SUCCEEDED\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "17882567-2478-47fd-a3fb-a53ba2c581bd", "name": "Resolved: as you said, with `RESOLVED_BY_OPERATOR`; or by a\nread-back that agreed with you, with `RESOLVED_BY_READ_BACK`.", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId", "resolution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"outcome\": \"SUCCEEDED\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent\": {\n \"agent_id\": \"\",\n \"did\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:4zgGKDcorLedXBy2pDOB47Hb7XwBrWlui2w5lbZNclT\",\n \"expires_at\": \"\",\n \"approved_at\": \"\",\n \"approver\": \"\",\n \"require_mfa\": \"\",\n \"rules\": [\n \"REQUIRE_MFA\",\n \"ACTION_REQUIRES_APPROVAL\"\n ],\n \"approved_by\": \"\"\n },\n \"arguments\": {},\n \"authorization\": {\n \"event_id\": \"\",\n \"mandate_id\": \"\",\n \"pom_digest\": \"sha-256:hL_VAEKSqQPXW_PWtZvUWa4uh2EkZ46Wvk1f8TlA_1r\"\n },\n \"completed_at\": \"\",\n \"connector_id\": \"\",\n \"contract\": \"mandaitor.execution/v1\",\n \"created_at\": \"\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"ALLOW\",\n \"reason\": \"\",\n \"mandate_id\": \"\",\n \"decided_at\": \"\"\n },\n \"dispatched_at\": \"\",\n \"execution_id\": \"exe_NZ3Q8LF0TIX5NGMZOPGD1TNKZW\",\n \"facts\": {},\n \"outcome\": {\n \"version_after\": \"\",\n \"transaction_ref\": \"\",\n \"target_status\": \"\",\n \"reason\": \"\",\n \"write_acknowledged\": \"\"\n },\n \"purpose\": \"\",\n \"receipt\": \"\",\n \"reconciliation\": {\n \"attempts\": \"\",\n \"last_attempt_at\": \"\",\n \"last_reason\": \"\",\n \"next_at\": \"\"\n },\n \"request_digest\": \"sha-256:20I3ar-ME6LqLH9JdafsGVdC0SfAntYzUVlI0sdnyeu\",\n \"resolution\": {\n \"resolved_by\": \"\",\n \"resolved_at\": \"\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n },\n \"result\": {},\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"RECORD_NOT_FOUND\",\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\",\n \"version_kind\": \"\"\n },\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"updated_at\": \"\",\n \"reservation\": {\n \"reservation_id\": \"\",\n \"mandate_id\": \"\",\n \"status\": \"RELEASED\",\n \"held_at\": \"\",\n \"counters\": [\n {\n \"kind\": \"total\",\n \"window\": \"P1W\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"limit\": \"\",\n \"delta\": \"\"\n },\n {\n \"kind\": \"count\",\n \"window\": \"P1D\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"limit\": \"\",\n \"delta\": \"\"\n }\n ],\n \"settled_at\": \"\",\n \"amount\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d827645c-d739-4d41-908f-9145b04dae7a", "name": "`INVALID_REQUEST`: not a valid resolution; `errors` lists each problem.", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId", "resolution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"outcome\": \"SUCCEEDED\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3f457b2-a7fd-424d-903b-3e16b2da051f", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId", "resolution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"outcome\": \"SUCCEEDED\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3a4413c-79ba-481f-99a7-9c98bfb60cd2", "name": "`NOT_A_PERSON`, or the caller lacks `tenant:write` in this tenant.", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId", "resolution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"outcome\": \"SUCCEEDED\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83a956bc-7c78-49db-9a1c-73bd48de71fe", "name": "`EXECUTION_NOT_FOUND`: no such execution in the caller's tenant", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId", "resolution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"outcome\": \"SUCCEEDED\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23221890-dc81-440c-8ba2-7949a9cd3813", "name": "`execution` is the execution as it is now.\n- `OUTCOME_CONTRADICTED`: a read-back settled it otherwise than\n you said; it is resolved as the read-back found.\n- `NOT_UNKNOWN`: it is not `UNKNOWN`, or it changed while being\n resolved.\n- `RESOLUTION_IN_PROGRESS`: Mandaitor or another person is\n settling it; read it again in a moment.", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId", "resolution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"outcome\": \"SUCCEEDED\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df3a87f7-05e1-4b3b-a135-0a2b44573040", "name": "`AUDIT_UNAVAILABLE`: the resolution could not be recorded on the\naudit chain, so nothing changed. Try again.", "originalRequest": { "url": { "path": [ "tenants", ":id", "executions", ":executionId", "resolution" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "executionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"outcome\": \"SUCCEEDED\",\n \"evidence\": \"\",\n \"transaction_ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] }, { "name": "scim", "description": "", "item": [ { "name": "v2", "description": "", "item": [ { "name": "Users", "description": "", "item": [ { "id": "60fb17da-5982-4efb-9661-5f98a7303d93", "name": "List provisioned users", "request": { "name": "List provisioned users", "description": {}, "url": { "path": [ "scim", "v2", "Users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "startIndex", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "count", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/scim+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b7862f34-621a-4422-ad67-79115676fa02", "name": "SCIM ListResponse", "originalRequest": { "url": { "path": [ "scim", "v2", "Users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "startIndex", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "count", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/scim+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/scim+json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c827208-c9fa-4238-af53-abd8eade19f9", "name": "Authentication required", "originalRequest": { "url": { "path": [ "scim", "v2", "Users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "startIndex", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "count", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7933a72c-962c-4e04-bec4-822387dd5a3c", "name": "Provision a new user", "request": { "name": "Provision a new user", "description": {}, "url": { "path": [ "scim", "v2", "Users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "key": "Accept", "value": "application/scim+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f40d0340-5a47-4643-9755-9edae32e24b6", "name": "User created", "originalRequest": { "url": { "path": [ "scim", "v2", "Users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "key": "Accept", "value": "application/scim+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/scim+json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c0204b4-0af7-4015-abd7-408c079b9165", "name": "Invalid request", "originalRequest": { "url": { "path": [ "scim", "v2", "Users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{userId}", "description": "", "item": [ { "id": "2a566dda-cc9c-4345-a3a9-619eaaf6194c", "name": "Get a provisioned user", "request": { "name": "Get a provisioned user", "description": {}, "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "40447d11-38e0-4c4a-85d2-c16758bed536", "name": "SCIM User", "originalRequest": { "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c871ab4b-2fe6-4060-8115-4e395359468b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1dea0d54-5c0c-427b-b184-d7dce14f13e9", "name": "Replace a user", "request": { "name": "Replace a user", "description": {}, "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e1f6dc9a-245e-41dd-b307-b828657e5480", "name": "User updated", "originalRequest": { "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "042a785b-42a9-43f9-9726-7a85dc57cb57", "name": "Resource not found", "originalRequest": { "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "030963f6-b070-4602-822e-35ef4792aaae", "name": "Partially update a user", "request": { "name": "Partially update a user", "description": {}, "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7bbc45c0-62f7-419d-9947-4001d8a9d4e0", "name": "User updated", "originalRequest": { "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05f2368c-b7c0-4f9c-b309-8379bab203fe", "name": "Resource not found", "originalRequest": { "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/scim+json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac05472c-c052-46c1-b5e2-184cd78f6018", "name": "Deprovision a user (revokes all mandates)", "request": { "name": "Deprovision a user (revokes all mandates)", "description": {}, "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "8b093282-1a7e-454a-a0a8-23cf48374084", "name": "User deleted", "originalRequest": { "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "25bc6cdc-517a-4849-8b91-2323b3d86fbf", "name": "Resource not found", "originalRequest": { "url": { "path": [ "scim", "v2", "Users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "health", "description": "", "item": [ { "id": "f1b64391-2893-4ab9-8a9a-8aef2da4cf50", "name": "Health/status check", "request": { "name": "Health/status check", "description": { "content": "Returns service health status. No sensitive data is exposed.\nSuitable for monitoring, load balancers, and Trust Center embedding.\n", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ffbc16d1-d326-42d3-8711-ab6642200c20", "name": "Service is healthy", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ok\",\n \"timestamp\": \"\",\n \"version\": \"\",\n \"stage\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49a67b40-029f-4686-96b1-91f3b5179e1a", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "775ccbb0-61a6-455e-9d08-aba1f54db377", "name": "Service is unavailable or degraded", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": ".well-known", "description": "", "item": [ { "name": "did.json", "description": "", "item": [ { "id": "f2d79463-4f0c-42e2-bbd3-f6916ccde050", "name": "Resolve the Mandaitor issuer DID document", "request": { "name": "Resolve the Mandaitor issuer DID document", "description": { "content": "Returns the W3C DID Document for the Mandaitor issuer DID\n(did:web:api.mandaitor.io). Contains the public key used to\nverify Proof-of-Mandate SD-JWT VCs.\n", "type": "text/plain" }, "url": { "path": [ ".well-known", "did.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/did+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "da5d3b60-1004-473f-8616-3b27ba1ea495", "name": "DID Document", "originalRequest": { "url": { "path": [ ".well-known", "did.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/did+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/did+json" } ], "body": "{\n \"@context\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"authentication\": [\n \"\",\n \"\"\n ],\n \"assertionMethod\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a8063a5-f4bb-4d10-b35b-a561f97f8133", "name": "Resource not found", "originalRequest": { "url": { "path": [ ".well-known", "did.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "trust.json", "description": "", "item": [ { "id": "c432f505-d051-4e0b-a239-4ee09f6d9f73", "name": "Public trust signals for machine-readable trust metadata", "request": { "name": "Public trust signals for machine-readable trust metadata", "description": { "content": "Returns machine-readable trust metadata including region, partition,\nissuer DID, data residency claims, and supported open standards.\nUnauthenticated and cache-friendly (5-minute client, 10-minute CDN).\n", "type": "text/plain" }, "url": { "path": [ ".well-known", "trust.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cdbf8c74-c6fe-469e-8bdc-e43e7bc304df", "name": "Trust signals", "originalRequest": { "url": { "path": [ ".well-known", "trust.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"schema_version\": \"\",\n \"region\": \"\",\n \"partition\": \"\",\n \"issuer_did\": \"\",\n \"did_document_url\": \"\",\n \"data_residency\": {\n \"primary_region\": \"\",\n \"partition\": \"\",\n \"jurisdiction\": \"\"\n },\n \"open_standards\": [\n \"\",\n \"\"\n ],\n \"build_version\": \"\",\n \"stage\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69eba604-7949-4d65-b41a-3688822d63e1", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ ".well-known", "trust.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07f8c914-a062-43f0-9fb8-6fec25c55644", "name": "Trust signals temporarily unavailable", "originalRequest": { "url": { "path": [ ".well-known", "trust.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "oauth-authorization-server", "description": "", "item": [ { "id": "84d1132d-acaf-46dd-a876-406124b65f68", "name": "MCP OAuth Authorization Server Metadata", "request": { "name": "MCP OAuth Authorization Server Metadata", "description": { "content": "The OAuth 2.0 Authorization Server Metadata (RFC 8414) of\n`POST /mcp/token`, where agents get their sessions. The same document\nis served at the domain's root, where RFC 8414 places it for this\nissuer and where MCP clients look for it:\n`https://api.mandaitor.io/.well-known/oauth-authorization-server/v1`.\n\nAgents authenticate with the client credentials grant and their\nregistry key (`private_key_jwt`). No browser flow exists yet:\n`response_types_supported` is empty, and the `authorization_endpoint`\nit names answers so.\n", "type": "text/plain" }, "url": { "path": [ ".well-known", "oauth-authorization-server" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1a8ce56a-4e50-48ce-afbd-282767d9b49e", "name": "Server metadata", "originalRequest": { "url": { "path": [ ".well-known", "oauth-authorization-server" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"issuer\": \"\",\n \"token_endpoint\": \"\",\n \"authorization_endpoint\": \"\",\n \"grant_types_supported\": [\n \"\",\n \"\"\n ],\n \"token_endpoint_auth_methods_supported\": [\n \"\",\n \"\"\n ],\n \"token_endpoint_auth_signing_alg_values_supported\": [\n \"\",\n \"\"\n ],\n \"dpop_signing_alg_values_supported\": [\n \"\",\n \"\"\n ],\n \"response_types_supported\": [\n \"\",\n \"\"\n ],\n \"service_documentation\": \"\",\n \"scopes_supported\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e847e2bf-e317-4c14-8cc5-d3b3438cdc84", "name": "Not found", "originalRequest": { "url": { "path": [ ".well-known", "oauth-authorization-server" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "did.json", "description": "", "item": [ { "id": "b2eefac7-3134-47b2-bbf7-22eeb13b4ca7", "name": "Resolve the Mandaitor issuer DID document (spec-compliant path)", "request": { "name": "Resolve the Mandaitor issuer DID document (spec-compliant path)", "description": { "content": "Spec-compliant resolution path for the issuer DID. The issuer DID is a\n*path* DID (`did:web:api.mandaitor.io:v1`), which per the W3C did:web\nspecification resolves to `https://api.mandaitor.io/v1/did.json` — this\nendpoint. Returns the same W3C DID Document as `/.well-known/did.json`,\nwhich is kept as an alias.\n", "type": "text/plain" }, "url": { "path": [ "did.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/did+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5ec551ef-1ef1-4388-a486-dbd7cb005b34", "name": "DID Document", "originalRequest": { "url": { "path": [ "did.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/did+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/did+json" } ], "body": "{\n \"@context\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"authentication\": [\n \"\",\n \"\"\n ],\n \"assertionMethod\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6287eb09-f1db-463a-83d8-5dcc6e2a02f0", "name": "Resource not found", "originalRequest": { "url": { "path": [ "did.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "events", "description": "", "item": [ { "id": "14ff44b9-1e0f-4d9f-a5be-5faa944affb4", "name": "Query all events for the tenant", "request": { "name": "Query all events for the tenant", "description": { "content": "Queries all audit events for the authenticated tenant, filtered by mandate_id.\nSupports optional event_type filtering and cursor-based pagination.\n", "type": "text/plain" }, "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Mandate ID to filter events by", "type": "text/plain" }, "key": "mandate_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of MANDATE_CREATED,MANDATE_SUSPENDED,MANDATE_REACTIVATED,MANDATE_REVOKED,VERIFICATION_ALLOWED,VERIFICATION_DENIED,ESCALATION_TRIGGERED)", "type": "text/plain" }, "key": "event_type", "value": "MANDATE_REVOKED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3fe72c5d-da2c-497a-a0d3-6a76b1304c65", "name": "Paginated list of events", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Mandate ID to filter events by", "type": "text/plain" }, "key": "mandate_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of MANDATE_CREATED,MANDATE_SUSPENDED,MANDATE_REACTIVATED,MANDATE_REVOKED,VERIFICATION_ALLOWED,VERIFICATION_DENIED,ESCALATION_TRIGGERED)", "type": "text/plain" }, "key": "event_type", "value": "MANDATE_REVOKED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"EXECUTION_FAILED\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n },\n {\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"MANDATE_CREATED\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"SERVICE\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78eb5ba3-be55-44f2-8f85-0d5f58b2fe1f", "name": "Authentication required", "originalRequest": { "url": { "path": [ "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Mandate ID to filter events by", "type": "text/plain" }, "key": "mandate_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of MANDATE_CREATED,MANDATE_SUSPENDED,MANDATE_REACTIVATED,MANDATE_REVOKED,VERIFICATION_ALLOWED,VERIFICATION_DENIED,ESCALATION_TRIGGERED)", "type": "text/plain" }, "key": "event_type", "value": "MANDATE_REVOKED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "421b8f48-a42e-40bd-aac0-c5d05877387c", "name": "Get a specific event by ID", "request": { "name": "Get a specific event by ID", "description": { "content": "Retrieves a single audit event by its ID. Requires the mandate_id query\nparameter to locate the event in the partition.\n", "type": "text/plain" }, "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Mandate ID the event belongs to", "type": "text/plain" }, "key": "mandate_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0d321327-c2f2-471d-99c3-3a704bdbac94", "name": "Event details", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Mandate ID the event belongs to", "type": "text/plain" }, "key": "mandate_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"event_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"event_type\": \"EXECUTION_DENIED\",\n \"timestamp\": \"\",\n \"actor\": {\n \"type\": \"ORGANIZATION\",\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"identity_provider\": \"\",\n \"identity_token_hash\": \"\"\n },\n \"details\": {},\n \"previous_event_hash\": \"\",\n \"event_hash\": \"\",\n \"kms_signature\": \"\",\n \"hash_algorithm\": \"\",\n \"signing_algorithm\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce8fa71e-c6f7-42d7-8030-888aa61c2301", "name": "Resource not found", "originalRequest": { "url": { "path": [ "events", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Mandate ID the event belongs to", "type": "text/plain" }, "key": "mandate_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "onboarding", "description": "", "item": [ { "name": "request", "description": "", "item": [ { "id": "cc6f2e1d-d516-4afe-a9d8-5b494f39c159", "name": "Submit an access request (no auth required)", "request": { "name": "Submit an access request (no auth required)", "description": { "content": "Submits a new tenant access request. No authentication required.\nThe request enters PENDING state and must be approved by an admin.\n", "type": "text/plain" }, "url": { "path": [ "onboarding", "request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"company_name\": \"\",\n \"contact_email\": \"\",\n \"use_case\": \"\",\n \"contact_name\": \"\",\n \"industry\": \"venture_capital\",\n \"website\": \"\",\n \"lead_source\": \"\",\n \"beta_track\": \"\",\n \"asset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8933d898-49c0-43aa-bbd7-6e915d2fb16e", "name": "Access request submitted", "originalRequest": { "url": { "path": [ "onboarding", "request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"company_name\": \"\",\n \"contact_email\": \"\",\n \"use_case\": \"\",\n \"contact_name\": \"\",\n \"industry\": \"venture_capital\",\n \"website\": \"\",\n \"lead_source\": \"\",\n \"beta_track\": \"\",\n \"asset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"request_id\": \"\",\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51567d30-e35c-4b8e-a273-13d3d29a34a3", "name": "Invalid request", "originalRequest": { "url": { "path": [ "onboarding", "request" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"company_name\": \"\",\n \"contact_email\": \"\",\n \"use_case\": \"\",\n \"contact_name\": \"\",\n \"industry\": \"venture_capital\",\n \"website\": \"\",\n \"lead_source\": \"\",\n \"beta_track\": \"\",\n \"asset\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "admin", "description": "", "item": [ { "name": "onboarding", "description": "", "item": [ { "id": "6a8847ce-57eb-487b-8b36-6519b112061e", "name": "List onboarding access requests (admin only)", "request": { "name": "List onboarding access requests (admin only)", "description": { "content": "Lists onboarding access requests. Supports optional status filtering\n(PENDING, APPROVED, REJECTED) and cursor-based pagination.\nRequires Cognito JWT with mandaitor-admins group membership.\n", "type": "text/plain" }, "url": { "path": [ "admin", "onboarding" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by request status (This can only be one of PENDING,APPROVED,REJECTED)", "type": "text/plain" }, "key": "status", "value": "REJECTED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c63cc82e-ad9a-4f79-bd49-7415aa36cedf", "name": "Paginated list of onboarding requests", "originalRequest": { "url": { "path": [ "admin", "onboarding" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by request status (This can only be one of PENDING,APPROVED,REJECTED)", "type": "text/plain" }, "key": "status", "value": "REJECTED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"requests\": [\n {\n \"request_id\": \"\",\n \"company_name\": \"\",\n \"contact_name\": \"\",\n \"contact_email\": \"\",\n \"use_case\": \"\",\n \"industry\": \"construction\",\n \"website\": \"\",\n \"lead_source\": \"\",\n \"beta_track\": \"\",\n \"asset\": \"\",\n \"status\": \"PENDING\",\n \"submitted_at\": \"\",\n \"reviewed_at\": \"\",\n \"reviewed_by\": \"\",\n \"tenant_id\": \"\"\n },\n {\n \"request_id\": \"\",\n \"company_name\": \"\",\n \"contact_name\": \"\",\n \"contact_email\": \"\",\n \"use_case\": \"\",\n \"industry\": \"real_estate\",\n \"website\": \"\",\n \"lead_source\": \"\",\n \"beta_track\": \"\",\n \"asset\": \"\",\n \"status\": \"REJECTED\",\n \"submitted_at\": \"\",\n \"reviewed_at\": \"\",\n \"reviewed_by\": \"\",\n \"tenant_id\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5495161c-299f-48e3-9622-4f8b39f50b16", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "onboarding" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by request status (This can only be one of PENDING,APPROVED,REJECTED)", "type": "text/plain" }, "key": "status", "value": "REJECTED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73f73a4f-fbc1-4299-9b8c-3324b1bfaa82", "name": "Admin group membership required", "originalRequest": { "url": { "path": [ "admin", "onboarding" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by request status (This can only be one of PENDING,APPROVED,REJECTED)", "type": "text/plain" }, "key": "status", "value": "REJECTED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{requestId}", "description": "", "item": [ { "name": "{action}", "description": "", "item": [ { "id": "330d5db1-873e-49a0-a072-65ff918137b5", "name": "Approve or reject an access request", "request": { "name": "Approve or reject an access request", "description": { "content": "Processes an admin action on an onboarding request.\nSupported values for `{action}`: `approve`, `reject`.\n", "type": "text/plain" }, "url": { "path": [ "admin", "onboarding", ":requestId", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "requestId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "reject", "key": "action", "disabled": false, "description": { "content": "(Required) (This can only be one of approve,reject)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9e0cd553-fd03-4b06-a8a5-1ed6d4386062", "name": "Request reviewed", "originalRequest": { "url": { "path": [ "admin", "onboarding", ":requestId", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "requestId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of approve,reject)", "type": "text/plain" }, "type": "any", "value": "reject", "key": "action" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5ab653c-1abe-4ece-8e61-e2be35299274", "name": "Tenant activated", "originalRequest": { "url": { "path": [ "admin", "onboarding", ":requestId", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "requestId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of approve,reject)", "type": "text/plain" }, "type": "any", "value": "reject", "key": "action" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"company_name\": \"\",\n \"plan\": \"\",\n \"status\": \"DEACTIVATED\",\n \"created_at\": \"\",\n \"api_keys\": [\n {\n \"key_id\": \"\",\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\"\n },\n {\n \"key_id\": \"\",\n \"name\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eae9730e-1b9b-4ff8-b9de-ec493be6842a", "name": "Invalid request", "originalRequest": { "url": { "path": [ "admin", "onboarding", ":requestId", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "requestId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of approve,reject)", "type": "text/plain" }, "type": "any", "value": "reject", "key": "action" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a113196-bc6e-47ba-acb0-3b7246fdf4fb", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "onboarding", ":requestId", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "requestId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of approve,reject)", "type": "text/plain" }, "type": "any", "value": "reject", "key": "action" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6907e0d6-e731-490d-8035-38369388913e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "admin", "onboarding", ":requestId", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "requestId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of approve,reject)", "type": "text/plain" }, "type": "any", "value": "reject", "key": "action" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "tenants", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "27341b3f-c54f-4066-be22-1a007221df42", "name": "Get tenant detail (admin)", "request": { "name": "Get tenant detail (admin)", "description": { "content": "Returns a single tenant's config, linked onboarding metadata, API key\ncount, and mandate status counts (capped at the first 600 mandates).\n\nRequires Cognito JWT with `mandaitor-admins` group membership.\n", "type": "text/plain" }, "url": { "path": [ "admin", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "356a66ab-efcf-41e3-989e-9c0cab8437c4", "name": "Tenant detail payload", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"display_name\": \"\",\n \"status\": \"\",\n \"api_key_count\": \"\",\n \"mandate_stats\": {\n \"total\": \"\",\n \"active\": \"\",\n \"suspended\": \"\",\n \"revoked\": \"\",\n \"expired\": \"\",\n \"draft\": \"\"\n },\n \"contact_name\": \"\",\n \"contact_email\": \"\",\n \"created_at\": \"\",\n \"usage_plan\": {\n \"tier\": \"standard\",\n \"rate_limit\": \"\",\n \"quota_limit\": \"\",\n \"quota_period\": \"\"\n },\n \"onboarding\": {\n \"request_id\": \"\",\n \"use_case\": \"\",\n \"website\": \"\",\n \"submitted_at\": \"\",\n \"reviewed_at\": \"\",\n \"reviewed_by\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2521aa8-371a-4bd5-a4f2-f01f1dff2847", "name": "Invalid request", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98c40fac-899e-44e4-a00d-1e221fd636eb", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d3666fc-0b7c-4d2c-afef-2f0550af3900", "name": "Caller is not in the mandaitor-admins group", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2382314-c59e-42c4-9879-27945280c5f1", "name": "Resource not found", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "kill-switch", "description": "", "item": [ { "id": "4158bb19-4308-4006-8737-fff9993ce04b", "name": "Emergency kill-switch — stop a tenant's executions and revoke its mandates", "request": { "name": "Emergency kill-switch — stop a tenant's executions and revoke its mandates", "description": { "content": "**EMERGENCY OPERATION** — Stops what a tenant's agents may do and\nrevokes its ACTIVE, SUSPENDED and PENDING_APPROVAL mandates. This is\nan irreversible bulk operation intended for security incidents,\ncompliance breaches, or contract terminations.\n\nIt takes effect on the execution path before it answers: every tool\nthe tenant has enabled is disabled, so from then on no execution is\ncreated, approved or dispatched, and the MCP server lists no tool.\nThe tenant enables its tools again, one by one, once the incident is\nover; the execution lists them as `tools_disabled`. While it runs, a\nrequest-bound decision is `DENY` with `KILL_SWITCH`, and an\nauthorization given before it is not redeemed.\n\nThe rest runs asynchronously. The call records an execution, queues\nit and returns `202 Accepted` with an `execution_id`. A worker then\nstops the tenant's executions waiting for an approval or for their\ndispatch, each `DENIED` with `KILL_SWITCH` (one already dispatched\nfinishes: nothing recalls it), and revokes the mandates page by\npage, checkpointing its progress on the execution, which\n`GET /admin/tenants/{id}/kill-switch/{executionId}` reports until the\nstatus is `COMPLETED` or `FAILED`. Executions for one tenant run one\nat a time; calling again while one is running queues a second\nexecution that finds nothing left to stop.\n\nRequires Cognito JWT with `mandaitor-admins` group membership. A\n`MANDATE_REVOKED` audit event is emitted per mandate with\n`details.kill_switch_triggered = true` and `details.execution_id`,\nand an `EXECUTION_DENIED` event per execution stopped, with\n`details.stage = kill_switch` and `details.kill_switch_execution_id`.\n", "type": "text/plain" }, "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "375aeb4b-576e-4129-a815-74c3f90b52e5", "name": "Kill-switch queued", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"execution_id\": \"\",\n \"status\": \"QUEUED\",\n \"status_path\": \"\",\n \"requested_at\": \"\",\n \"requested_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f93c990a-1b9a-4577-9b8c-61ae6913c3eb", "name": "Invalid request", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1986c524-36ba-44f4-be77-3e7b5d0423a8", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4e81ab4-361d-4c8c-a17b-7546d99f7dd4", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1168cf4-68a2-4044-8e8f-7323f9440dbd", "name": "List recent kill-switch executions for a tenant", "request": { "name": "List recent kill-switch executions for a tenant", "description": { "content": "The twenty most recent kill-switch executions for the tenant, newest\nfirst, with their status and counts. Requires Cognito JWT with\n`mandaitor-admins` group membership.\n", "type": "text/plain" }, "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9888a366-8034-48b9-bd72-5d45e40150c8", "name": "Recent executions", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"executions\": [\n {\n \"execution_id\": \"\",\n \"tenant_id\": \"\",\n \"status\": \"RUNNING\",\n \"reason\": \"\",\n \"requested_by\": \"\",\n \"requested_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"updated_at\": \"\",\n \"phase\": \"TOOLS\",\n \"tools_disabled\": [\n {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"connector_id\": \"\",\n \"environment\": \"b8yy6pt6zk6abk6e\"\n },\n {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"connector_id\": \"\",\n \"environment\": \"nq\"\n }\n ],\n \"executions_cancelled\": \"\",\n \"executions_in_flight\": \"\",\n \"executions_busy\": \"\",\n \"executions_failed\": \"\",\n \"revoked_count\": \"\",\n \"skipped_count\": \"\",\n \"failed_count\": \"\",\n \"audit_event_failures\": \"\",\n \"pages_processed\": \"\",\n \"continuations\": \"\",\n \"attempts\": \"\",\n \"last_error\": \"\"\n },\n {\n \"execution_id\": \"\",\n \"tenant_id\": \"\",\n \"status\": \"COMPLETED\",\n \"reason\": \"\",\n \"requested_by\": \"\",\n \"requested_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"updated_at\": \"\",\n \"phase\": \"TOOLS\",\n \"tools_disabled\": [\n {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"connector_id\": \"\",\n \"environment\": \"vszij5m95hxndnm5\"\n },\n {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"connector_id\": \"\",\n \"environment\": \"fm-j7h\"\n }\n ],\n \"executions_cancelled\": \"\",\n \"executions_in_flight\": \"\",\n \"executions_busy\": \"\",\n \"executions_failed\": \"\",\n \"revoked_count\": \"\",\n \"skipped_count\": \"\",\n \"failed_count\": \"\",\n \"audit_event_failures\": \"\",\n \"pages_processed\": \"\",\n \"continuations\": \"\",\n \"attempts\": \"\",\n \"last_error\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4404ed5e-4d3d-49bb-9f9f-6d340ea53973", "name": "Invalid request", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50642531-922f-470e-ad1f-1050e6955ed4", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1138a56-6fe8-4443-8de1-f837433988ee", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{executionId}", "description": "", "item": [ { "id": "0c26b8bd-406d-4faf-943e-15456cf95cfa", "name": "Get the status of a kill-switch execution", "request": { "name": "Get the status of a kill-switch execution", "description": { "content": "Progress of one kill-switch execution: status, how many mandates were\nrevoked, skipped or failed so far, and the last error if any. Poll\nthis after a `202` until `status` is `COMPLETED` or `FAILED`.\nRequires Cognito JWT with `mandaitor-admins` group membership.\n", "type": "text/plain" }, "url": { "path": [ "admin", "tenants", ":id", "kill-switch", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "executionId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1adebf44-ecde-475d-8c6a-b1ba33dfd0a6", "name": "Execution status", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"execution_id\": \"\",\n \"tenant_id\": \"\",\n \"status\": \"RUNNING\",\n \"reason\": \"\",\n \"requested_by\": \"\",\n \"requested_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"updated_at\": \"\",\n \"phase\": \"EXECUTIONS\",\n \"tools_disabled\": [\n {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"connector_id\": \"\",\n \"environment\": \"sa4f0fg2nrst\"\n },\n {\n \"tool_id\": \"\",\n \"version\": \"\",\n \"connector_id\": \"\",\n \"environment\": \"yppp0tmydgv4vuij2rtvtz-4hivk\"\n }\n ],\n \"executions_cancelled\": \"\",\n \"executions_in_flight\": \"\",\n \"executions_busy\": \"\",\n \"executions_failed\": \"\",\n \"revoked_count\": \"\",\n \"skipped_count\": \"\",\n \"failed_count\": \"\",\n \"audit_event_failures\": \"\",\n \"pages_processed\": \"\",\n \"continuations\": \"\",\n \"attempts\": \"\",\n \"last_error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51e6db70-f914-4e39-a931-8b499d57e98d", "name": "Invalid request", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a90a970-e380-41da-984a-0c90b66ece13", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d20284e-c8a5-4155-98b7-7b609127b6f3", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63b45dcf-0d12-4a83-8110-d17c848dc5d8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "admin", "tenants", ":id", "kill-switch", ":executionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "executionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "system-mode", "description": "", "item": [ { "id": "c48a35e1-ef14-4456-b22b-f777d15ca716", "name": "Get current system operational mode", "request": { "name": "Get current system operational mode", "description": { "content": "Returns the current system mode (growth, sustain, maintenance, frozen)\nand associated metadata. Requires Cognito JWT with `mandaitor-admins`\ngroup membership.\n", "type": "text/plain" }, "url": { "path": [ "admin", "system-mode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "be308886-17a9-45a8-b128-bf01daa5b4bd", "name": "Current system mode", "originalRequest": { "url": { "path": [ "admin", "system-mode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mode\": \"maintenance\",\n \"reason\": \"\",\n \"changed_at\": \"\",\n \"changed_by\": \"\",\n \"estimated_duration_minutes\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f60f334a-72d5-46e0-90cb-63f2c933ef43", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "system-mode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e280f834-d614-44f1-abd0-fd5d77893d54", "name": "Set system operational mode", "request": { "name": "Set system operational mode", "description": { "content": "Changes the system operational mode. This immediately affects all API\nendpoints:\n\n- **growth** — Normal operation. All features active.\n- **sustain** — Normal operation. No new features (policy only).\n- **maintenance** — All authenticated endpoints return 503.\n- **frozen** — Write endpoints return 503. Reads still work.\n\nMode changes propagate within ~10 seconds via in-memory cache TTL.\nRequires Cognito JWT with `mandaitor-admins` group membership.\n", "type": "text/plain" }, "url": { "path": [ "admin", "system-mode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mode\": \"frozen\",\n \"reason\": \"\",\n \"estimated_duration_minutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9ca6d3f3-68e5-4d0f-8496-ff2d5a130d0c", "name": "System mode updated", "originalRequest": { "url": { "path": [ "admin", "system-mode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mode\": \"frozen\",\n \"reason\": \"\",\n \"estimated_duration_minutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mode\": \"maintenance\",\n \"reason\": \"\",\n \"changed_at\": \"\",\n \"changed_by\": \"\",\n \"estimated_duration_minutes\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f98baf46-2e72-483f-931d-c5fe12797e47", "name": "Invalid request", "originalRequest": { "url": { "path": [ "admin", "system-mode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mode\": \"frozen\",\n \"reason\": \"\",\n \"estimated_duration_minutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81f9d4c6-2b57-4a4b-951f-cfbdbbfe3884", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "system-mode" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mode\": \"frozen\",\n \"reason\": \"\",\n \"estimated_duration_minutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "auth", "description": "", "item": [ { "name": "{action}", "description": "", "item": [ { "id": "60157a68-3a21-4bcf-a131-1c0cd26dbfcc", "name": "Authentication proxy for Cognito operations", "request": { "name": "Authentication proxy for Cognito operations", "description": { "content": "Proxies authentication requests to Cognito from the browser, bypassing\nthe ESC Cognito IDP endpoint DNS resolution issue. The `{action}`\npath parameter determines the operation:\n\n- **login** — `InitiateAuth` with `USER_PASSWORD_AUTH`\n- **respond** — `RespondToAuthChallenge` (NEW_PASSWORD_REQUIRED, MFA)\n- **refresh** — `REFRESH_TOKEN_AUTH`\n- **sign-out** — `GlobalSignOut`\n- **forgot-password** — `ForgotPassword`\n- **confirm-forgot-password** — `ConfirmForgotPassword`\n", "type": "text/plain" }, "url": { "path": [ "admin", "auth", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "forgot-password", "key": "action", "disabled": false, "description": { "content": "(Required) (This can only be one of login,respond,refresh,sign-out,forgot-password,confirm-forgot-password)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "89110e92-6e3c-4c38-b568-cee699558050", "name": "Authentication operation succeeded", "originalRequest": { "url": { "path": [ "admin", "auth", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of login,respond,refresh,sign-out,forgot-password,confirm-forgot-password)", "type": "text/plain" }, "type": "any", "value": "forgot-password", "key": "action" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da558c08-928b-412e-b0fd-ea37fa911f81", "name": "Invalid request", "originalRequest": { "url": { "path": [ "admin", "auth", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of login,respond,refresh,sign-out,forgot-password,confirm-forgot-password)", "type": "text/plain" }, "type": "any", "value": "forgot-password", "key": "action" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "197ed1a1-a054-4e55-b36c-4f1270034090", "name": "Invalid credentials or expired session", "originalRequest": { "url": { "path": [ "admin", "auth", ":action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of login,respond,refresh,sign-out,forgot-password,confirm-forgot-password)", "type": "text/plain" }, "type": "any", "value": "forgot-password", "key": "action" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "billing", "description": "", "item": [ { "name": "sync-customers", "description": "", "item": [ { "id": "fe06ff5a-9a6f-4be2-9918-8135a0affd21", "name": "Reconcile product-owned Stripe Customers", "request": { "name": "Reconcile product-owned Stripe Customers", "description": { "content": "Admin-only, dry-run-first Customer inventory. Every mapped Customer is\nretrieved read-only and checked against the exact Mandaitor product,\nstage, and opaque owner metadata. The default request never writes.\n`{ \"apply\": true }` creates Customers only for unmapped tenants and is\nrejected unless `BILLING_CUSTOMER_SYNC_APPLY_ENABLED=true`. It never\ncreates subscriptions and is not scheduled automatically.\n", "type": "text/plain" }, "url": { "path": [ "admin", "billing", "sync-customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7a816644-26dd-489e-bf06-f1997dfa90ea", "name": "Sync result", "originalRequest": { "url": { "path": [ "admin", "billing", "sync-customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mode\": \"dry_run\",\n \"scanned\": \"\",\n \"verified_owned\": \"\",\n \"legacy_mapping_requires_review\": \"\",\n \"missing_customer\": \"\",\n \"deleted_customer\": \"\",\n \"metadata_mismatch\": \"\",\n \"remote_lookup_failed\": \"\",\n \"created\": \"\",\n \"failed\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65059655-b27b-438b-95ed-d6a4d12f2d10", "name": "Authentication required", "originalRequest": { "url": { "path": [ "admin", "billing", "sync-customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5610098e-7584-4b7f-bb10-6d2698f31219", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "admin", "billing", "sync-customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apply\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "tenant", "description": "", "item": [ { "name": "workspaces", "description": "", "item": [ { "name": "me", "description": "", "item": [ { "id": "d551c194-16d0-4e89-94e0-06164f1a81ce", "name": "Get current user's workspace entitlements", "request": { "name": "Get current user's workspace entitlements", "description": { "content": "Returns the authenticated subject's workspace access for the current\ntenant context. If no explicit entitlement row exists, the response is\nderived from the tenant RBAC context: the Product Workspace is enabled\nby default, while the Partner & Project Workspace is enabled by default\nonly for tenant administrators and platform administrators. Requires\nCognito JWT or another authorizer-supported tenant principal.\n", "type": "text/plain" }, "url": { "path": [ "tenant", "workspaces", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f715f547-7b51-4042-90bd-af27fe0afe24", "name": "Current user's workspace entitlements returned", "originalRequest": { "url": { "path": [ "tenant", "workspaces", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"user_id\": \"\",\n \"workspaces\": {\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"updated_at\": \"\",\n \"source\": \"explicit\",\n \"granted_by\": \"\",\n \"granted_at\": \"\",\n \"updated_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8597462-c5ca-4a51-ad73-6b4c0ab06797", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenant", "workspaces", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "683082e5-8d5d-4b34-87f3-6bc3460735d0", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenant", "workspaces", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "users", "description": "", "item": [ { "name": "{subjectId}", "description": "", "item": [ { "name": "workspaces", "description": "", "item": [ { "id": "dc2f0928-fe12-4751-9a17-7e76560b8e18", "name": "Get workspace entitlements for a tenant user", "request": { "name": "Get workspace entitlements for a tenant user", "description": { "content": "Returns workspace access for the URL-encoded canonical subject ID in the\ncurrent tenant. Reading another subject's entitlement requires\n`tenant:read` permission. If no explicit entitlement exists, default\nworkspace access is resolved using the caller's tenant RBAC context.\n", "type": "text/plain" }, "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId", "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dbb7274e-aa3b-4bc3-b2ac-983af2a9b897", "name": "Tenant user's workspace entitlements returned", "originalRequest": { "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"user_id\": \"\",\n \"workspaces\": {\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"updated_at\": \"\",\n \"source\": \"explicit\",\n \"granted_by\": \"\",\n \"granted_at\": \"\",\n \"updated_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a916aecf-5a38-4f01-a9bb-d5f36173a9c9", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63b7032e-43d6-4f90-ae68-e51f6daa3583", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02ddc7b0-d125-413a-bf53-147db7a92801", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "TQTmKXePgib7/NVjuITqtyE:2BNf1TQH/nKm@HtA2YIb./m1rXMVbGDXh8me34iPF.7kyCeDwyR2913OMxZ7Lk4", "key": "subjectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cf441df0-32ab-4a64-b397-0223896a1df4", "name": "Update workspace entitlements for a tenant user", "request": { "name": "Update workspace entitlements for a tenant user", "description": { "content": "Creates or replaces the explicit workspace entitlement row for the\nURL-encoded canonical subject ID in the current tenant. Setting both\nworkspace flags to `false` stores the entitlement as `REVOKED` and causes\nboth workspaces to be disabled in the response. Emits an immutable\n`WORKSPACE_ENTITLEMENT_UPDATED` audit event. Requires `tenant:write`\npermission.\n", "type": "text/plain" }, "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId", "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4710361a-543c-417b-acf0-caccd736354c", "name": "Tenant user's workspace entitlements updated", "originalRequest": { "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"user_id\": \"\",\n \"workspaces\": {\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"updated_at\": \"\",\n \"source\": \"explicit\",\n \"granted_by\": \"\",\n \"granted_at\": \"\",\n \"updated_by\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4a74fdc-030f-4dc6-887d-c0bc98837f15", "name": "Invalid request", "originalRequest": { "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aa73de8-f029-470e-b8f4-dc1df0b33706", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b994531-2657-4673-9388-fc60ecb49fb4", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "tenant", "users", ":subjectId", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) URL-encoded canonical subject ID resolved by the authorizer.", "type": "text/plain" }, "type": "any", "value": "8iv_o2id_6wmiD-xA7AqYb4T@7Z06dBWakRn.HfYu@0Z1MgZK/m-yvAGMFpcXNuis2AX57FHz9kbiy9Mr8uPJo6ePntiI1WpCbpVwRn8D-Y@akE9i3cz855JUGpi_mB80otUryA_W4FDWsmN:tlD4G5g7geryiF:fB0Nhk911L0Qp6yHATiivDwvteB5s2SmcOoUeJugvv06OhRt@Wi.y:dZJGPIGzbTbV8QChSb6fK@7hpQ", "key": "subjectId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"product_workspace\": \"\",\n \"partner_project_workspace\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "widgets", "description": "", "item": [ { "name": "{widgetId}", "description": "", "item": [ { "name": "config", "description": "", "item": [ { "id": "46a9f93e-1a53-4308-9f52-5e588c898b28", "name": "Public widget config for embed (no auth)", "request": { "name": "Public widget config for embed (no auth)", "description": { "content": "Returns the public-safe widget configuration for embedding. No authentication\nrequired. Sensitive fields (secrets, internal IDs) are stripped from the response.\n", "type": "text/plain" }, "url": { "path": [ "widgets", ":widgetId", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "widgetId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d11cbab8-e715-49f4-b148-a28196fab8a0", "name": "Public widget configuration", "originalRequest": { "url": { "path": [ "widgets", ":widgetId", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "widgetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"widget_id\": \"\",\n \"tenant_name\": \"\",\n \"branding\": {},\n \"enabled_idps\": [\n \"\",\n \"\"\n ],\n \"taxonomy_libraries\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bbaf7a0-fa55-4e14-be7d-87745ab1a50f", "name": "Resource not found", "originalRequest": { "url": { "path": [ "widgets", ":widgetId", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "widgetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "webhooks", "description": "", "item": [ { "name": "stripe", "description": "", "item": [ { "id": "6fa12883-e8aa-45f8-976e-1feccba38817", "name": "Stripe webhook endpoint", "request": { "name": "Stripe webhook endpoint", "description": { "content": "Receives and processes Stripe webhook events. Authentication is\nperformed via Stripe signature verification (not API key or JWT).\nHandles invoice lifecycle events (payment succeeded/failed/finalized)\nand subscription changes (updated/deleted).\n", "type": "text/plain" }, "url": { "path": [ "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "11379682-6278-455a-a195-318c1cae2c12", "name": "Webhook received and processed", "originalRequest": { "url": { "path": [ "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"received\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b6514f3-2ee0-4bef-8a12-11ff4fbeb00d", "name": "Invalid signature or malformed payload", "originalRequest": { "url": { "path": [ "webhooks", "stripe" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "drift", "description": "", "item": [ { "name": "agents", "description": "", "item": [ { "id": "4f833502-da7c-4fb3-a70b-4100812be433", "name": "List agents with drift summaries", "request": { "name": "List agents with drift summaries", "description": { "content": "**@experimental** Aggregates drift session data across all mandates\nto produce per-agent summaries including average/max drift scores,\nsession counts, and last activity timestamps.\n", "type": "text/plain" }, "url": { "path": [ "drift", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "10ef4d1b-6835-48c7-8864-4f2e1a5e410e", "name": "Array of agent drift summaries", "originalRequest": { "url": { "path": [ "drift", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"delegate_subject_id\": \"\",\n \"mandate_count\": \"\",\n \"avg_drift_score\": \"\",\n \"max_drift_score\": \"\",\n \"sessions_with_drift\": \"\",\n \"total_sessions\": \"\",\n \"last_activity\": \"\",\n \"display_name\": \"\"\n },\n {\n \"delegate_subject_id\": \"\",\n \"mandate_count\": \"\",\n \"avg_drift_score\": \"\",\n \"max_drift_score\": \"\",\n \"sessions_with_drift\": \"\",\n \"total_sessions\": \"\",\n \"last_activity\": \"\",\n \"display_name\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "167349f6-0468-41c6-a2de-bdd47df59988", "name": "Authentication required", "originalRequest": { "url": { "path": [ "drift", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{delegateId}", "description": "", "item": [ { "name": "sessions", "description": "", "item": [ { "id": "bc622280-2f88-4009-b325-11946f2b3f21", "name": "List drift sessions for a specific agent", "request": { "name": "List drift sessions for a specific agent", "description": { "content": "**@experimental** Queries the drift sessions table to retrieve all\nrecent session windows for a given delegate, enriched with computed\ndrift scores and mandate context.\n", "type": "text/plain" }, "url": { "path": [ "drift", "agents", ":delegateId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lookback window in hours.", "type": "text/plain" }, "key": "hours", "value": "24" } ], "variable": [ { "type": "any", "value": "", "key": "delegateId", "disabled": false, "description": { "content": "(Required) The delegate subject ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2ce14e21-4d70-4f08-94ea-a9acc22fa9a1", "name": "Array of drift sessions for the agent", "originalRequest": { "url": { "path": [ "drift", "agents", ":delegateId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lookback window in hours.", "type": "text/plain" }, "key": "hours", "value": "24" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The delegate subject ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "delegateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"mandate_id\": \"\",\n \"delegate_subject_id\": \"\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"action_count\": \"\",\n \"drift_score\": {\n \"semantic_distance\": \"\",\n \"sequence_deviation\": \"\",\n \"frequency_anomaly\": \"\",\n \"scope_expansion\": \"\",\n \"aggregate\": \"\",\n \"drift_detected\": \"\"\n },\n \"intent_purpose\": \"\"\n },\n {\n \"mandate_id\": \"\",\n \"delegate_subject_id\": \"\",\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"action_count\": \"\",\n \"drift_score\": {\n \"semantic_distance\": \"\",\n \"sequence_deviation\": \"\",\n \"frequency_anomaly\": \"\",\n \"scope_expansion\": \"\",\n \"aggregate\": \"\",\n \"drift_detected\": \"\"\n },\n \"intent_purpose\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b9d8fa2-92df-436b-9e3d-1da3aa1064e3", "name": "Missing delegate ID or tenant context", "originalRequest": { "url": { "path": [ "drift", "agents", ":delegateId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lookback window in hours.", "type": "text/plain" }, "key": "hours", "value": "24" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The delegate subject ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "delegateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f82777ac-a2b0-497d-af87-cc40a148eb29", "name": "Authentication required", "originalRequest": { "url": { "path": [ "drift", "agents", ":delegateId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lookback window in hours.", "type": "text/plain" }, "key": "hours", "value": "24" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The delegate subject ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "delegateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "events", "description": "", "item": [ { "id": "fd8f9d5b-725f-462b-bbd5-d13007558665", "name": "List recent drift detection events", "request": { "name": "List recent drift detection events", "description": { "content": "**@experimental** Queries the tenant-wide event timeline for\nDRIFT_DETECTED and DRIFT_RESOLVED events, enriched with the drift\nscore from the event details. Results are newest-first and paginate\nvia an opaque cursor; follow `next_cursor` until it is absent to\nwalk the full drift history.\n", "type": "text/plain" }, "url": { "path": [ "drift", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of events to return per page.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9ba71a36-c73d-4402-9206-da0ab3e09516", "name": "One page of drift events", "originalRequest": { "url": { "path": [ "drift", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of events to return per page.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"event_id\": \"\",\n \"timestamp\": \"\",\n \"mandate_id\": \"\",\n \"delegate_subject_id\": \"\",\n \"action\": \"DRIFT_DETECTED\",\n \"drift_score\": {\n \"semantic_distance\": \"\",\n \"sequence_deviation\": \"\",\n \"frequency_anomaly\": \"\",\n \"scope_expansion\": \"\",\n \"aggregate\": \"\",\n \"drift_detected\": \"\"\n }\n },\n {\n \"event_id\": \"\",\n \"timestamp\": \"\",\n \"mandate_id\": \"\",\n \"delegate_subject_id\": \"\",\n \"action\": \"DRIFT_DETECTED\",\n \"drift_score\": {\n \"semantic_distance\": \"\",\n \"sequence_deviation\": \"\",\n \"frequency_anomaly\": \"\",\n \"scope_expansion\": \"\",\n \"aggregate\": \"\",\n \"drift_detected\": \"\"\n }\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcaefc44-1b19-477a-a515-2c3055ccd811", "name": "Missing tenant context or invalid pagination cursor", "originalRequest": { "url": { "path": [ "drift", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of events to return per page.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "353384a0-75e8-4689-93e0-b6cbaa6dfbd1", "name": "Authentication required", "originalRequest": { "url": { "path": [ "drift", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of events to return per page.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque base64url cursor from a previous response's `next_cursor`.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "agents", "description": "", "item": [ { "id": "9e9afd36-daa8-4dd4-916e-d3f2b6c2859e", "name": "Register a new AI agent identity", "request": { "name": "Register a new AI agent identity", "description": { "content": "Creates a new agent identity with a DID, KMS-backed key pair, and\ninitial ACTIVE status. The agent can then be bound to mandates.\n", "type": "text/plain" }, "url": { "path": [ "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"algorithm\": \"ES256\",\n \"public_key_jwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-384\",\n \"x\": \"\",\n \"y\": \"\",\n \"alg\": \"ES256\"\n },\n \"metadata\": {\n \"key_0\": 4249.832885598586,\n \"key_1\": \"string\",\n \"key_2\": 7017,\n \"key_3\": 5803.165205426184,\n \"key_4\": true\n },\n \"environment\": \"vtlonh2o2bhp2cfkq1j6ac\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "590c235b-3153-4469-b724-9b9909754512", "name": "Agent registered", "originalRequest": { "url": { "path": [ "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"algorithm\": \"ES256\",\n \"public_key_jwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-384\",\n \"x\": \"\",\n \"y\": \"\",\n \"alg\": \"ES256\"\n },\n \"metadata\": {\n \"key_0\": 4249.832885598586,\n \"key_1\": \"string\",\n \"key_2\": 7017,\n \"key_3\": 5803.165205426184,\n \"key_4\": true\n },\n \"environment\": \"vtlonh2o2bhp2cfkq1j6ac\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"SUSPENDED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ACTIVE\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"hyivnoefrv49ev-yw2-kll1\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23e20583-d7e8-4311-9e08-da6f7541ffef", "name": "Invalid request", "originalRequest": { "url": { "path": [ "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"algorithm\": \"ES256\",\n \"public_key_jwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-384\",\n \"x\": \"\",\n \"y\": \"\",\n \"alg\": \"ES256\"\n },\n \"metadata\": {\n \"key_0\": 4249.832885598586,\n \"key_1\": \"string\",\n \"key_2\": 7017,\n \"key_3\": 5803.165205426184,\n \"key_4\": true\n },\n \"environment\": \"vtlonh2o2bhp2cfkq1j6ac\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e17fa5be-9eb6-4470-8e63-759ccaf6cba0", "name": "Authentication required", "originalRequest": { "url": { "path": [ "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"algorithm\": \"ES256\",\n \"public_key_jwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-384\",\n \"x\": \"\",\n \"y\": \"\",\n \"alg\": \"ES256\"\n },\n \"metadata\": {\n \"key_0\": 4249.832885598586,\n \"key_1\": \"string\",\n \"key_2\": 7017,\n \"key_3\": 5803.165205426184,\n \"key_4\": true\n },\n \"environment\": \"vtlonh2o2bhp2cfkq1j6ac\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f42fdea2-9c78-4672-82b9-dd064d271cbd", "name": "List registered agents", "request": { "name": "List registered agents", "description": { "content": "Returns a paginated list of agent identities for the authenticated tenant.\n", "type": "text/plain" }, "url": { "path": [ "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of ACTIVE,SUSPENDED,REVOKED)", "type": "text/plain" }, "key": "status", "value": "SUSPENDED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e2779bf3-4760-48d0-b20e-206c88d95359", "name": "Paginated list of agents", "originalRequest": { "url": { "path": [ "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of ACTIVE,SUSPENDED,REVOKED)", "type": "text/plain" }, "key": "status", "value": "SUSPENDED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"ACTIVE\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"REVOKED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"pcvycpg1179ywje1gyqkilukf\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"REVOKED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"REVOKED\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"xkj774tbzviov3g4yxh22wr\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2693e38e-9ab0-4c19-b82d-a7ac44b068c0", "name": "Authentication required", "originalRequest": { "url": { "path": [ "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of ACTIVE,SUSPENDED,REVOKED)", "type": "text/plain" }, "key": "status", "value": "SUSPENDED" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "c7bba989-fee0-4b8d-85f9-58b9b75ee5a2", "name": "Get agent details", "request": { "name": "Get agent details", "description": {}, "url": { "path": [ "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "58c59f3c-9b3a-42b1-a3b5-66a09a191436", "name": "Agent details", "originalRequest": { "url": { "path": [ "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"SUSPENDED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ACTIVE\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"hyivnoefrv49ev-yw2-kll1\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ce68db9-6cb5-420f-9fba-89d15bd1113b", "name": "Authentication required", "originalRequest": { "url": { "path": [ "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dd6345a-aa65-4aa3-86f6-8915609c0c83", "name": "Agent not found", "originalRequest": { "url": { "path": [ "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "did", "description": "", "item": [ { "id": "06762d67-53e1-46b7-9923-0a02cb9b03f5", "name": "Resolve agent DID Document", "request": { "name": "Resolve agent DID Document", "description": {}, "url": { "path": [ "agents", ":id", "did" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/did+json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1c1e5617-ddf2-4d80-bf24-8a86df8ed334", "name": "DID Document", "originalRequest": { "url": { "path": [ "agents", ":id", "did" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/did+json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/did+json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d8b01b0-d0d6-41d0-83b6-31f81e366c64", "name": "Agent not found", "originalRequest": { "url": { "path": [ "agents", ":id", "did" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "rotate", "description": "", "item": [ { "id": "e7b6da5f-d608-4da5-af8c-b3fd27ef29a5", "name": "Rotate agent cryptographic key", "request": { "name": "Rotate agent cryptographic key", "description": {}, "url": { "path": [ "agents", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"algorithm\": \"ES256\",\n \"public_key_jwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-384\",\n \"x\": \"\",\n \"y\": \"\",\n \"alg\": \"ES256\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4533a05f-8f6b-4ade-9ede-67e5f52de309", "name": "Key rotated", "originalRequest": { "url": { "path": [ "agents", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"algorithm\": \"ES256\",\n \"public_key_jwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-384\",\n \"x\": \"\",\n \"y\": \"\",\n \"alg\": \"ES256\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"SUSPENDED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ACTIVE\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"hyivnoefrv49ev-yw2-kll1\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcc2a060-7a23-42ca-b5e2-5d973bcded0c", "name": "Agent not found", "originalRequest": { "url": { "path": [ "agents", ":id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"algorithm\": \"ES256\",\n \"public_key_jwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-384\",\n \"x\": \"\",\n \"y\": \"\",\n \"alg\": \"ES256\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "bind", "description": "", "item": [ { "id": "d5eb2a76-8342-436c-8c9b-dfd358f2e9fb", "name": "Bind agent to a mandate", "request": { "name": "Bind agent to a mandate", "description": { "content": "Lets the agent present a mandate in its MCP sessions. The mandate must be\ndelegated to this agent: its `delegate.subject_id` is the agent's DID or\nagent id. A binding grants no authority of its own: `/mcp/token` issues\na session only to an agent bound to a mandate that names it, and an\nexecution is decided on the agent's active mandates, bound or not.\n", "type": "text/plain" }, "url": { "path": [ "agents", ":id", "bind" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mandate_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "60d7226c-d2e0-4e84-b232-b074b8a8bd07", "name": "Agent bound to mandate", "originalRequest": { "url": { "path": [ "agents", ":id", "bind" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mandate_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"REVOKED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ACTIVE\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"REVOKED\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"lvvqeg80r6c38m9gjv6ujhxqmus0\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aec2e447-da89-4b09-bb0b-cff364f35434", "name": "Agent or mandate not found", "originalRequest": { "url": { "path": [ "agents", ":id", "bind" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mandate_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0619743-a167-4e94-bd8d-789d46f3095e", "name": "The mandate is not delegated to this agent (`code` is `MANDATE_DELEGATE_MISMATCH`).", "originalRequest": { "url": { "path": [ "agents", ":id", "bind" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mandate_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{mandateId}", "description": "", "item": [ { "id": "0c943683-ddf3-4bf5-b024-e0450c735309", "name": "Unbind agent from a mandate", "request": { "name": "Unbind agent from a mandate", "description": { "content": "MCP sessions the agent already holds stop using the mandate at once.\n", "type": "text/plain" }, "url": { "path": [ "agents", ":id", "bind", ":mandateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "mandateId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "15b1ed13-5136-4ab0-bac1-4a618850deee", "name": "Agent unbound from mandate", "originalRequest": { "url": { "path": [ "agents", ":id", "bind", ":mandateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "mandateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"SUSPENDED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ACTIVE\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"hyivnoefrv49ev-yw2-kll1\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7acf76d0-843d-48ce-85e1-7159de6b4b76", "name": "Agent not found", "originalRequest": { "url": { "path": [ "agents", ":id", "bind", ":mandateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "mandateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "suspend", "description": "", "item": [ { "id": "778f1ede-6cd6-4060-aae4-940baacff850", "name": "Suspend an agent", "request": { "name": "Suspend an agent", "description": { "content": "Ends every MCP session the agent holds, at once. The agent cannot obtain a\ntoken while suspended, and its earlier sessions stay dead after it is\nreactivated.\n", "type": "text/plain" }, "url": { "path": [ "agents", ":id", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d8a2fb1d-510d-4f77-9f5f-6a10dedb2415", "name": "Agent suspended", "originalRequest": { "url": { "path": [ "agents", ":id", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"SUSPENDED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ACTIVE\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"hyivnoefrv49ev-yw2-kll1\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e17f67d5-19f6-46ac-b786-976745800952", "name": "Agent not found", "originalRequest": { "url": { "path": [ "agents", ":id", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reactivate", "description": "", "item": [ { "id": "e59b8748-08d3-4511-b884-4072e0e61333", "name": "Reactivate a suspended agent", "request": { "name": "Reactivate a suspended agent", "description": { "content": "The agent may request a new token from `/mcp/token`. Sessions issued\nbefore the suspension stay dead.\n", "type": "text/plain" }, "url": { "path": [ "agents", ":id", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "321cf545-f07d-4f5d-8db0-93b7ccd6869d", "name": "Agent reactivated", "originalRequest": { "url": { "path": [ "agents", ":id", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"SUSPENDED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ACTIVE\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"hyivnoefrv49ev-yw2-kll1\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5098ba-f345-4347-871c-56f864b2387f", "name": "Agent not found", "originalRequest": { "url": { "path": [ "agents", ":id", "reactivate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "revoke", "description": "", "item": [ { "id": "85babdd9-a4a8-426f-a7da-4f861fd3c084", "name": "Permanently revoke an agent", "request": { "name": "Permanently revoke an agent", "description": { "content": "Revokes the agent's keys and ends every MCP session it holds. The agent\ncan never obtain a token again.\n", "type": "text/plain" }, "url": { "path": [ "agents", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "0bcf7f42-6c9b-4244-95e3-eb7de63048a0", "name": "Agent revoked", "originalRequest": { "url": { "path": [ "agents", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agent_id\": \"\",\n \"tenant_id\": \"\",\n \"did\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"SUSPENDED\",\n \"verification_methods\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ROTATED\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"publicKeyJwk\": {},\n \"status\": \"ACTIVE\"\n }\n ],\n \"bound_mandates\": [\n \"\",\n \"\"\n ],\n \"environment\": \"hyivnoefrv49ev-yw2-kll1\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf0db0b4-c914-4245-9801-2e2a3b311fb5", "name": "Agent not found", "originalRequest": { "url": { "path": [ "agents", ":id", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "mcp", "description": "", "item": [ { "name": "token", "description": "", "item": [ { "id": "68b372a2-f0e6-4ec7-934b-13099c1cccaf", "name": "Exchange agent credentials for MCP access token", "request": { "name": "Exchange agent credentials for MCP access token", "description": { "content": "OAuth 2.0 client_credentials grant for MCP agents. The agent\npresents a signed JWT assertion and receives a scoped access\ntoken bound to its mandates. The parameters may be sent\nform-encoded, as OAuth clients send them, or as a JSON object.\n\nThe assertion (`private_key_jwt`) is signed with the agent's active\nregistry key, which `kid` may name. It must carry `iss` and `sub` naming\nthe agent (its DID), `aud` naming the authorization server — its\nissuer (`https://api.mandaitor.io/v1`) or this endpoint's URL — a\nunique `jti` of at most 256 characters, and an `exp` no more than\nfive minutes ahead (a minute of clock skew is tolerated). Each\nassertion is accepted once: presenting the same `jti` again returns\n401, so sign a new assertion for every token request. `client_id`\nmay be left out, since the assertion's `iss` names the agent\n(RFC 7521); when both are sent, they must agree.\n\n`resource` (RFC 8707) names what the token is for. The MCP server's\nURL (`https://api.mandaitor.io/v1/mcp`) gives a session that only\nthe MCP server accepts. The API's base URL, or no `resource`, gives\none that only the API's own routes accept. Anything else is 400\n`invalid_target`.\n\n**A session bound to the agent's key** (DPoP, RFC 9449). A `DPoP`\nheader with a proof for this request, signed by a key the client\nholds, binds the session to that key: it is issued with\n`token_type` `DPoP` and lasts an hour, and every request with it must\ncarry a fresh proof signed by the same key (`McpSessionDPoP`), so\nthe token alone is of no use to anyone who takes it. `/executions`\ntakes only such a session. Without a proof, the session is a bearer\none (`token_type` `Bearer`) and lasts 15 minutes: the MCP server and\n`GET /mcp/sessions/{id}` take it, `/executions` does not.\n", "type": "text/plain" }, "url": { "path": [ "mcp", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A DPoP proof (RFC 9449) for this request, asking for a session\nbound to its key: `htm` `POST`, `htu` this endpoint's URL, and no\n`ath`, since no token is presented yet. See `McpSessionDPoP` for\nwhat a proof is.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_assertion_type", "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" }, { "disabled": false, "description": { "content": "(Required) Signed JWT assertion, accepted once. Carries a unique `jti` and an `exp` no more than five minutes ahead.", "type": "text/plain" }, "key": "client_assertion", "value": "" }, { "disabled": false, "description": { "content": "Agent DID. Optional, as the assertion's `iss` names the agent; when sent, it must agree.", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Space-separated mandate scopes", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "What the token is for (RFC 8707): the MCP server's URL, or the API's base URL. A session is accepted only by the one it names; without a resource, by the API.", "type": "text/plain" }, "key": "resource", "value": "" } ] }, "auth": null }, "response": [ { "id": "5a962a9c-e263-4117-b0c7-41ee4a529f41", "name": "Access token issued", "originalRequest": { "url": { "path": [ "mcp", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A DPoP proof (RFC 9449) for this request, asking for a session\nbound to its key: `htm` `POST`, `htu` this endpoint's URL, and no\n`ath`, since no token is presented yet. See `McpSessionDPoP` for\nwhat a proof is.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_assertion_type", "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" }, { "disabled": false, "description": { "content": "(Required) Signed JWT assertion, accepted once. Carries a unique `jti` and an `exp` no more than five minutes ahead.", "type": "text/plain" }, "key": "client_assertion", "value": "" }, { "disabled": false, "description": { "content": "Agent DID. Optional, as the assertion's `iss` names the agent; when sent, it must agree.", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Space-separated mandate scopes", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "What the token is for (RFC 8707): the MCP server's URL, or the API's base URL. A session is accepted only by the one it names; without a resource, by the API.", "type": "text/plain" }, "key": "resource", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"\",\n \"token_type\": \"DPoP\",\n \"expires_in\": \"\",\n \"scope\": \"\",\n \"session_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "009679e8-b91d-4f8b-8ac7-b137306d1073", "name": "`invalid_request` (a missing or repeated parameter, or a body that is\nneither a form nor JSON), `unsupported_grant_type`, `invalid_target`\n(a `resource` other than the MCP server or the API), or\n`invalid_dpop_proof`: more than one `DPoP` header, or a proof that\nis not for this request, does not verify with its own key, is\noutside its window, or was used before.", "originalRequest": { "url": { "path": [ "mcp", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A DPoP proof (RFC 9449) for this request, asking for a session\nbound to its key: `htm` `POST`, `htu` this endpoint's URL, and no\n`ath`, since no token is presented yet. See `McpSessionDPoP` for\nwhat a proof is.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_assertion_type", "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" }, { "disabled": false, "description": { "content": "(Required) Signed JWT assertion, accepted once. Carries a unique `jti` and an `exp` no more than five minutes ahead.", "type": "text/plain" }, "key": "client_assertion", "value": "" }, { "disabled": false, "description": { "content": "Agent DID. Optional, as the assertion's `iss` names the agent; when sent, it must agree.", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Space-separated mandate scopes", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "What the token is for (RFC 8707): the MCP server's URL, or the API's base URL. A session is accepted only by the one it names; without a resource, by the API.", "type": "text/plain" }, "key": "resource", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"error_description\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6e4106c-1073-4a6d-b109-53b1d47a105b", "name": "Invalid client credentials, including an assertion that has already been used", "originalRequest": { "url": { "path": [ "mcp", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A DPoP proof (RFC 9449) for this request, asking for a session\nbound to its key: `htm` `POST`, `htu` this endpoint's URL, and no\n`ath`, since no token is presented yet. See `McpSessionDPoP` for\nwhat a proof is.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "client_assertion_type", "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" }, { "disabled": false, "description": { "content": "(Required) Signed JWT assertion, accepted once. Carries a unique `jti` and an `exp` no more than five minutes ahead.", "type": "text/plain" }, "key": "client_assertion", "value": "" }, { "disabled": false, "description": { "content": "Agent DID. Optional, as the assertion's `iss` names the agent; when sent, it must agree.", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Space-separated mandate scopes", "type": "text/plain" }, "key": "scope", "value": "" }, { "disabled": false, "description": { "content": "What the token is for (RFC 8707): the MCP server's URL, or the API's base URL. A session is accepted only by the one it names; without a resource, by the API.", "type": "text/plain" }, "key": "resource", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "dd4b20b8-3d09-4ffd-94b8-cc4d05703cf2", "name": "Send one MCP message (Streamable HTTP)", "request": { "name": "Send one MCP message (Streamable HTTP)", "description": { "content": "The MCP server. The body is one JSON-RPC 2.0 message of the Model\nContext Protocol. The server speaks 2025-11-25, 2025-06-18 and\n2025-03-26, and answers every request with one JSON object, never\na stream. A batch is refused, and a notification gets 202 and no body.\n\n- `initialize`: the negotiated version, `tools` as the only\n capability, and instructions for the model.\n- `ping`.\n- `tools/list`: the tools the tenant enabled that a mandate naming\n the agent could back now, then the server's own `get_execution`. A\n tool's name is its id with each dot an underscore\n (`sap_purchase_requisition_release`).\n- `tools/call`: one execution, requested as `POST /executions`\n requests it, from the tool's arguments and an optional `purpose`\n for the approver. The call waits up to about 20 seconds for the\n execution to settle and answers with its outcome. One still\n running, or waiting for a person's approval, is answered with its\n state and id, for `get_execution`. While 50 calls are already\n waiting, across every agent, a call answers at once instead. A repeat of the same call by the\n same agent names the same execution while it runs, and for 10\n minutes after it ends. A denial or a failure is a tool error\n (`isError: true`); an unknown or not enabled tool is a JSON-RPC\n error (-32602). The result's `structuredContent` is the execution\n as `GET /executions/{id}` returns it.\n\nAuthenticated with a session from `POST /mcp/token` issued for this\nserver (its `resource` this URL): a bearer session, as stock MCP\nclients hold, or one bound to the agent's key, sent as `DPoP` with a\nproof for each request. Without one, the 401's `WWW-Authenticate`\nnames the protected resource metadata (RFC 9728):\n`https://api.mandaitor.io/.well-known/oauth-protected-resource/v1/mcp`.\nA browser's request from an origin this API does not serve is\nrefused with 403.\n\nAn agent may send 60 requests a minute, whatever they ask; past that,\neach is refused with 429 before anything is read. A tool call also\ncounts against the agent's 30 executions a minute, and past those it is\na tool error that says when to try again.\n", "type": "text/plain" }, "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "disabled": false, "description": { "content": "The version negotiated at `initialize`, sent after it. Without it, 2025-03-26 is assumed. (This can only be one of 2025-11-25,2025-06-18,2025-03-26)", "type": "text/plain" }, "key": "MCP-Protocol-Version", "value": "2025-03-26" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"method\": \"\",\n \"params\": {\n \"key_0\": 1114\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c1f18a5e-bdc1-441b-a22b-58621375add0", "name": "The answer to a request, a JSON-RPC result or error", "originalRequest": { "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "disabled": false, "description": { "content": "The version negotiated at `initialize`, sent after it. Without it, 2025-03-26 is assumed. (This can only be one of 2025-11-25,2025-06-18,2025-03-26)", "type": "text/plain" }, "key": "MCP-Protocol-Version", "value": "2025-03-26" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"method\": \"\",\n \"params\": {\n \"key_0\": 1114\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"result\": {\n \"key_0\": 2420\n },\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0725772-b91e-4eda-85b5-f3ce0493adf2", "name": "A notification, or a response, accepted. No body.", "originalRequest": { "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "disabled": false, "description": { "content": "The version negotiated at `initialize`, sent after it. Without it, 2025-03-26 is assumed. (This can only be one of 2025-11-25,2025-06-18,2025-03-26)", "type": "text/plain" }, "key": "MCP-Protocol-Version", "value": "2025-03-26" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"method\": \"\",\n \"params\": {\n \"key_0\": 1114\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2177c5b6-dfc9-4767-aa38-2045784a0d96", "name": "Not one JSON-RPC 2.0 message, or an MCP-Protocol-Version the server does not speak", "originalRequest": { "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "disabled": false, "description": { "content": "The version negotiated at `initialize`, sent after it. Without it, 2025-03-26 is assumed. (This can only be one of 2025-11-25,2025-06-18,2025-03-26)", "type": "text/plain" }, "key": "MCP-Protocol-Version", "value": "2025-03-26" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"method\": \"\",\n \"params\": {\n \"key_0\": 1114\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"result\": {\n \"key_0\": 2420\n },\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db6307a2-670d-4381-b9e7-9e49aacd5d1c", "name": "No session issued for this server, or a session bound to a key\nsent without a valid proof (`invalid_dpop_proof`) or as `Bearer`.", "originalRequest": { "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "disabled": false, "description": { "content": "The version negotiated at `initialize`, sent after it. Without it, 2025-03-26 is assumed. (This can only be one of 2025-11-25,2025-06-18,2025-03-26)", "type": "text/plain" }, "key": "MCP-Protocol-Version", "value": "2025-03-26" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"method\": \"\",\n \"params\": {\n \"key_0\": 1114\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "`Bearer resource_metadata=\"…\"`, with `error=\"invalid_token\"` when a\ntoken was sent. For a session bound to a key,\n`DPoP algs=\"ES256 ES384\", error=\"…\", error_description=\"…\", resource_metadata=\"…\"`.\n", "type": "text/plain" }, "key": "WWW-Authenticate", "value": "" } ], "body": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"result\": {\n \"key_0\": 2420\n },\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f20a857-4ab6-4d67-83f5-5062349d6557", "name": "The request's Origin is not one this API serves", "originalRequest": { "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "disabled": false, "description": { "content": "The version negotiated at `initialize`, sent after it. Without it, 2025-03-26 is assumed. (This can only be one of 2025-11-25,2025-06-18,2025-03-26)", "type": "text/plain" }, "key": "MCP-Protocol-Version", "value": "2025-03-26" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"method\": \"\",\n \"params\": {\n \"key_0\": 1114\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"result\": {\n \"key_0\": 2420\n },\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "070b280a-f616-451e-a374-fe800b834aa6", "name": "More than 60 requests by this agent in the current minute: a\nJSON-RPC error with code -32029 and no id. Nothing was read. Retry\nafter `Retry-After`, the seconds until the minute ends. The gateway\nalso answers 429, with `{\"message\":\"Too Many Requests\"}`, when the\nrequests of every agent together pass the server's throttle.", "originalRequest": { "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "disabled": false, "description": { "content": "The version negotiated at `initialize`, sent after it. Without it, 2025-03-26 is assumed. (This can only be one of 2025-11-25,2025-06-18,2025-03-26)", "type": "text/plain" }, "key": "MCP-Protocol-Version", "value": "2025-03-26" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"method\": \"\",\n \"params\": {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": 2853\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"jsonrpc\": \"2.0\",\n \"id\": \"\",\n \"result\": {\n \"key_0\": false,\n \"key_1\": 387.8195891344305,\n \"key_2\": 83.85539673394504\n },\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bd24b47-c3ed-40d2-bea2-585398e5f979", "name": "Open a server-sent event stream (not offered)", "request": { "name": "Open a server-sent event stream (not offered)", "description": { "content": "Always 405. The server sends no messages of its own, so it offers no stream.", "type": "text/plain" }, "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "74d925e9-08f4-471a-8ab8-98d33eb4a401", "name": "No stream is offered", "originalRequest": { "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Allow", "value": "" } ], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b521c8f-29c5-46b2-8e5e-0bbd797a08a0", "name": "End an MCP session (not offered)", "request": { "name": "End an MCP session (not offered)", "description": { "content": "Always 405. The server keeps no MCP session, so there is none to end.", "type": "text/plain" }, "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "4b26413b-b35a-436f-9c9c-cf29329928c9", "name": "There is no session to end", "originalRequest": { "url": { "path": [ "mcp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Method Not Allowed", "code": 405, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Allow", "value": "" } ], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "authorize", "description": "", "item": [ { "id": "ca10900f-6bcc-4dba-a595-8636676fafb2", "name": "OAuth authorization endpoint (no browser flow yet)", "request": { "name": "OAuth authorization endpoint (no browser flow yet)", "description": { "content": "The authorization endpoint the server metadata names, because MCP\nclients refuse metadata without one. Mandaitor issues sessions only to\nregistered agents, with the client credentials grant at\n`POST /mcp/token`. Signing in as a person through an MCP client is not\navailable yet. Always 400 `unsupported_response_type`.\n", "type": "text/plain" }, "url": { "path": [ "mcp", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e5603541-6ddc-4407-b97a-8a289364219e", "name": "No browser flow is offered", "originalRequest": { "url": { "path": [ "mcp", "authorize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"error_description\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sessions", "description": "", "item": [ { "name": "{id}", "description": "", "item": [ { "id": "21d3747f-8854-4cf9-8c92-556fdbcb9d38", "name": "Get MCP session details", "request": { "name": "Get MCP session details", "description": { "content": "Requires the session's own access token (`Authorization: Bearer mcp_…`,\nor `DPoP mcp_…` with a proof for a session bound to the agent's key);\na token for a different session returns 404. So does a session whose\nagent has been suspended or revoked since it was issued.\n", "type": "text/plain" }, "url": { "path": [ "mcp", "sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8e63560d-31ae-47e5-896e-d36d821ad909", "name": "Session details", "originalRequest": { "url": { "path": [ "mcp", "sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session_id\": \"\",\n \"tenant_id\": \"\",\n \"agent_id\": \"\",\n \"agent_did\": \"\",\n \"mandate_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"expires_at\": \"\",\n \"last_active_at\": \"\",\n \"call_count\": \"\",\n \"cnf\": {\n \"jkt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a9c7d02-93b2-4d7c-88c7-9c9f8f5a2faa", "name": "No usable agent session: `invalid_token` for a missing, expired or\nended session, or a bound one sent as `Bearer`; `invalid_dpop_proof`\nfor a bound session whose proof is missing, repeated, not for this\nrequest and token, not signed by the session's key, outside its\nwindow, or used before.", "originalRequest": { "url": { "path": [ "mcp", "sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "`Bearer`, with `error=\"invalid_token\"` when a token was sent. For a\nsession bound to a key, `DPoP algs=\"ES256 ES384\", error=\"…\", error_description=\"…\"`.\n", "type": "text/plain" }, "key": "WWW-Authenticate", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1a03771-0c98-4fdf-a788-3be2e0a79518", "name": "Session not found, expired, or ended by its agent's suspension or revocation", "originalRequest": { "url": { "path": [ "mcp", "sessions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Required with a session bound to the agent's key, sent as\n`Authorization: DPoP mcp_…`: a fresh proof for this request and this\ntoken (`McpSessionDPoP`). Not sent with a bearer session.\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "consents", "description": "", "item": [ { "id": "e706f2d7-a93d-43f4-905c-057c0df66734", "name": "Create a consent request for human-in-the-loop approval", "request": { "name": "Create a consent request for human-in-the-loop approval", "description": {}, "url": { "path": [ "consents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"agent_did\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"urgency\": \"CRITICAL\",\n \"ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7a77be49-7f86-44de-af2a-0cf213e300b7", "name": "Consent request created (or auto-approved by policy)", "originalRequest": { "url": { "path": [ "consents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"agent_did\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"urgency\": \"CRITICAL\",\n \"ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"consent_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"agent_did\": \"\",\n \"approver_subject_id\": \"\",\n \"approver_display_name\": \"\",\n \"status\": \"SUPERSEDED\",\n \"urgency\": \"LOW\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"decision\": {\n \"decided_by\": \"\",\n \"decided_at\": \"\",\n \"comment\": \"\",\n \"auto_policy_id\": \"\"\n },\n \"execution\": {\n \"execution_id\": \"\",\n \"approval_digest\": \"\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"facts\": {},\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\"\n },\n \"require_mfa\": \"\",\n \"rules\": [\n \"\",\n \"\"\n ],\n \"purpose\": \"\"\n },\n \"notification\": {\n \"status\": \"NOT_SENT\",\n \"channel\": \"email\",\n \"at\": \"\",\n \"reason\": \"RATE_LIMITED\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5014d153-f5db-4226-b188-d28960ae7dea", "name": "Invalid request", "originalRequest": { "url": { "path": [ "consents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"agent_did\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"urgency\": \"CRITICAL\",\n \"ttl_seconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "pending", "description": "", "item": [ { "id": "e541a6c5-c677-4ecc-ab95-1d5b963ba87f", "name": "List pending consent requests for the authenticated user", "request": { "name": "List pending consent requests for the authenticated user", "description": { "content": "The pending consent requests of the caller's own tenant that name the caller as approver, in one page of up to `limit`. An execution's approval past its `expires_at` is left out: it can no longer be decided.", "type": "text/plain" }, "url": { "path": [ "consents", "pending" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c13a48cf-ba42-4964-bdab-cccc0c4769b4", "name": "The pending consent requests naming the caller", "originalRequest": { "url": { "path": [ "consents", "pending" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"consent_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"agent_did\": \"\",\n \"approver_subject_id\": \"\",\n \"approver_display_name\": \"\",\n \"status\": \"APPROVED\",\n \"urgency\": \"CRITICAL\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"decision\": {\n \"decided_by\": \"\",\n \"decided_at\": \"\",\n \"comment\": \"\",\n \"auto_policy_id\": \"\"\n },\n \"execution\": {\n \"execution_id\": \"\",\n \"approval_digest\": \"\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"facts\": {},\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\"\n },\n \"require_mfa\": \"\",\n \"rules\": [\n \"\",\n \"\"\n ],\n \"purpose\": \"\"\n },\n \"notification\": {\n \"status\": \"SENDING\",\n \"channel\": \"email\",\n \"at\": \"\",\n \"reason\": \"RATE_LIMITED\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"consent_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"agent_did\": \"\",\n \"approver_subject_id\": \"\",\n \"approver_display_name\": \"\",\n \"status\": \"PENDING\",\n \"urgency\": \"LOW\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"decision\": {\n \"decided_by\": \"\",\n \"decided_at\": \"\",\n \"comment\": \"\",\n \"auto_policy_id\": \"\"\n },\n \"execution\": {\n \"execution_id\": \"\",\n \"approval_digest\": \"\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"facts\": {},\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\"\n },\n \"require_mfa\": \"\",\n \"rules\": [\n \"\",\n \"\"\n ],\n \"purpose\": \"\"\n },\n \"notification\": {\n \"status\": \"NOT_SENT\",\n \"channel\": \"email\",\n \"at\": \"\",\n \"reason\": \"RATE_LIMITED\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n }\n ],\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3d586c3-418c-45b2-82f9-17ad4d5f40eb", "name": "Invalid query parameters", "originalRequest": { "url": { "path": [ "consents", "pending" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{id}", "description": "", "item": [ { "id": "97406943-495b-49d9-96af-0ecc90fbc5ec", "name": "Get a consent request by ID", "request": { "name": "Get a consent request by ID", "description": {}, "url": { "path": [ "consents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e44b603d-267b-44db-aaa5-9b70f9f98ca1", "name": "Consent request details", "originalRequest": { "url": { "path": [ "consents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"consent_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"agent_did\": \"\",\n \"approver_subject_id\": \"\",\n \"approver_display_name\": \"\",\n \"status\": \"SUPERSEDED\",\n \"urgency\": \"LOW\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"decision\": {\n \"decided_by\": \"\",\n \"decided_at\": \"\",\n \"comment\": \"\",\n \"auto_policy_id\": \"\"\n },\n \"execution\": {\n \"execution_id\": \"\",\n \"approval_digest\": \"\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"facts\": {},\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\"\n },\n \"require_mfa\": \"\",\n \"rules\": [\n \"\",\n \"\"\n ],\n \"purpose\": \"\"\n },\n \"notification\": {\n \"status\": \"NOT_SENT\",\n \"channel\": \"email\",\n \"at\": \"\",\n \"reason\": \"RATE_LIMITED\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5d4c468-fe62-49ff-8b26-a1d25f302da6", "name": "Consent request not found", "originalRequest": { "url": { "path": [ "consents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "resolve", "description": "", "item": [ { "id": "3135ba9b-af01-42d1-bc4c-b48517050431", "name": "Approve or reject a consent request", "request": { "name": "Approve or reject a consent request", "description": {}, "url": { "path": [ "consents", ":id", "resolve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVED\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "108af8ff-a05d-4983-9b2f-9c90d7c58983", "name": "Consent request resolved", "originalRequest": { "url": { "path": [ "consents", ":id", "resolve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVED\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"consent_id\": \"\",\n \"tenant_id\": \"\",\n \"mandate_id\": \"\",\n \"agent_id\": \"\",\n \"agent_did\": \"\",\n \"approver_subject_id\": \"\",\n \"approver_display_name\": \"\",\n \"status\": \"SUPERSEDED\",\n \"urgency\": \"LOW\",\n \"tool_call\": {\n \"tool_name\": \"\",\n \"arguments\": {}\n },\n \"reason\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"decision\": {\n \"decided_by\": \"\",\n \"decided_at\": \"\",\n \"comment\": \"\",\n \"auto_policy_id\": \"\"\n },\n \"execution\": {\n \"execution_id\": \"\",\n \"approval_digest\": \"\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"scope\": {\n \"action\": \"\",\n \"resource\": \"\"\n },\n \"facts\": {},\n \"target\": {\n \"connector_id\": \"\",\n \"record\": \"\",\n \"version\": \"\"\n },\n \"require_mfa\": \"\",\n \"rules\": [\n \"\",\n \"\"\n ],\n \"purpose\": \"\"\n },\n \"notification\": {\n \"status\": \"NOT_SENT\",\n \"channel\": \"email\",\n \"at\": \"\",\n \"reason\": \"RATE_LIMITED\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ada5a668-4a1c-4c2e-a8a9-b24e471f8c37", "name": "Consent request not found", "originalRequest": { "url": { "path": [ "consents", ":id", "resolve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVED\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e5909af-0186-4e7b-8638-5c4f050d83a3", "name": "Consent request already resolved; or `EXECUTION_APPROVAL`: the\nconsent is an execution's approval, which only\n`POST /executions/{id}/approval` decides.", "originalRequest": { "url": { "path": [ "consents", ":id", "resolve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVED\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "consent-policies", "description": "", "item": [ { "id": "490687dd-258b-4dea-b34a-ea5013da407f", "name": "Create an auto-approval policy", "request": { "name": "Create an auto-approval policy", "description": {}, "url": { "path": [ "consent-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"rules\": [\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"wed\",\n \"tue\"\n ]\n }\n },\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"thu\",\n \"wed\"\n ]\n }\n }\n ],\n \"description\": \"\",\n \"priority\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "499e6a3b-4ab6-4da8-a14a-f4ceb56de5fa", "name": "Consent policy created", "originalRequest": { "url": { "path": [ "consent-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"rules\": [\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"wed\",\n \"tue\"\n ]\n }\n },\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"thu\",\n \"wed\"\n ]\n }\n }\n ],\n \"description\": \"\",\n \"priority\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policy_id\": \"\",\n \"tenant_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"rules\": [\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"tue\",\n \"thu\"\n ]\n }\n },\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"fri\",\n \"sat\"\n ]\n }\n }\n ],\n \"priority\": \"\",\n \"enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d222e976-2e68-44cb-9dfe-29d6d46b28ee", "name": "Invalid request", "originalRequest": { "url": { "path": [ "consent-policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"rules\": [\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"wed\",\n \"tue\"\n ]\n }\n },\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"thu\",\n \"wed\"\n ]\n }\n }\n ],\n \"description\": \"\",\n \"priority\": \"\",\n \"enabled\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1dcd57ea-76a7-4f19-a7fe-95c5510a5ba0", "name": "List consent policies for the tenant", "request": { "name": "List consent policies for the tenant", "description": {}, "url": { "path": [ "consent-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "71b7d0c5-de36-4b07-b877-0fa0ee600676", "name": "Paginated list of consent policies", "originalRequest": { "url": { "path": [ "consent-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"policy_id\": \"\",\n \"tenant_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"rules\": [\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"sat\",\n \"fri\"\n ]\n }\n },\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"mon\",\n \"thu\"\n ]\n }\n }\n ],\n \"priority\": \"\",\n \"enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"policy_id\": \"\",\n \"tenant_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"rules\": [\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"wed\",\n \"sat\"\n ]\n }\n },\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"fri\",\n \"wed\"\n ]\n }\n }\n ],\n \"priority\": \"\",\n \"enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"total_count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c0d8c7e-42b0-405f-9cd1-97ca78c231ed", "name": "Invalid query parameters", "originalRequest": { "url": { "path": [ "consent-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "cafc8d7a-43fa-40ef-8a2c-d3ec7a92aaef", "name": "Get a consent policy by ID", "request": { "name": "Get a consent policy by ID", "description": {}, "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ba02f907-05fa-4f3f-9acd-b1ba2cb59dce", "name": "Consent policy details", "originalRequest": { "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policy_id\": \"\",\n \"tenant_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"rules\": [\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"tue\",\n \"thu\"\n ]\n }\n },\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"fri\",\n \"sat\"\n ]\n }\n }\n ],\n \"priority\": \"\",\n \"enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30f93ac9-dbed-41c2-8d7e-131f02846753", "name": "Consent policy not found", "originalRequest": { "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9042459-10ec-463c-8aae-fd6095a69890", "name": "Update a consent policy", "request": { "name": "Update a consent policy", "description": {}, "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"rules\": [\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"sun\",\n \"sun\"\n ]\n }\n },\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"tue\",\n \"thu\"\n ]\n }\n }\n ],\n \"priority\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5f5d4916-8b60-4692-9b2e-b53f61339077", "name": "Consent policy updated", "originalRequest": { "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"rules\": [\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"sun\",\n \"sun\"\n ]\n }\n },\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"tue\",\n \"thu\"\n ]\n }\n }\n ],\n \"priority\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policy_id\": \"\",\n \"tenant_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"rules\": [\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"tue\",\n \"thu\"\n ]\n }\n },\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"fri\",\n \"sat\"\n ]\n }\n }\n ],\n \"priority\": \"\",\n \"enabled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63201a57-bb50-4c7e-abaf-06b33092943f", "name": "Consent policy not found", "originalRequest": { "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"rules\": [\n {\n \"effect\": \"auto_approve\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"sun\",\n \"sun\"\n ]\n }\n },\n {\n \"effect\": \"require_approval\",\n \"agent_ids\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"max_amount\": \"\",\n \"time_window\": {\n \"start\": \"\",\n \"end\": \"\",\n \"days\": [\n \"tue\",\n \"thu\"\n ]\n }\n }\n ],\n \"priority\": \"\",\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6df7a7ed-465c-482e-948d-f0de79a6f3dd", "name": "Delete a consent policy", "request": { "name": "Delete a consent policy", "description": {}, "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "95b39889-a343-4186-b779-08052f9ec05c", "name": "Consent policy deleted", "originalRequest": { "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f7528355-23bc-41dd-b7c4-94ce67f28a03", "name": "Consent policy not found", "originalRequest": { "url": { "path": [ "consent-policies", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "connectors", "description": "", "item": [ { "name": "catalog", "description": "", "item": [ { "id": "71fb5bd3-1790-4e04-ab6a-5da68c141139", "name": "List the connector catalog", "request": { "name": "List the connector catalog", "description": { "content": "Enterprise systems Mandaitor can govern. Each catalog entry lists the\nregistered tools that act through the connector and the fields a\ntenant must configure. The mock adapters once listed with\n`configurable: false` retired in execution roadmap E2.11.\n", "type": "text/plain" }, "url": { "path": [ "connectors", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1e36f871-02b3-4f0f-9ca5-6488c121d810", "name": "Connector catalog", "originalRequest": { "url": { "path": [ "connectors", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"connectors\": [\n {\n \"type\": \"\",\n \"display_name\": \"\",\n \"vendor\": \"\",\n \"description\": \"\",\n \"maturity\": \"pilot\",\n \"configurable\": \"\",\n \"tools\": [\n {\n \"tool\": \"\",\n \"effect\": \"read\",\n \"description\": \"\"\n },\n {\n \"tool\": \"\",\n \"effect\": \"write\",\n \"description\": \"\"\n }\n ],\n \"config_fields\": [\n {\n \"name\": \"\",\n \"label\": \"\",\n \"type\": \"password\",\n \"required\": \"\",\n \"secret\": \"\",\n \"placeholder\": \"\"\n },\n {\n \"name\": \"\",\n \"label\": \"\",\n \"type\": \"url\",\n \"required\": \"\",\n \"secret\": \"\",\n \"placeholder\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"display_name\": \"\",\n \"vendor\": \"\",\n \"description\": \"\",\n \"maturity\": \"pilot\",\n \"configurable\": \"\",\n \"tools\": [\n {\n \"tool\": \"\",\n \"effect\": \"write\",\n \"description\": \"\"\n },\n {\n \"tool\": \"\",\n \"effect\": \"read\",\n \"description\": \"\"\n }\n ],\n \"config_fields\": [\n {\n \"name\": \"\",\n \"label\": \"\",\n \"type\": \"url\",\n \"required\": \"\",\n \"secret\": \"\",\n \"placeholder\": \"\"\n },\n {\n \"name\": \"\",\n \"label\": \"\",\n \"type\": \"password\",\n \"required\": \"\",\n \"secret\": \"\",\n \"placeholder\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "taxonomies", "description": "", "item": [ { "id": "d3a3f6c1-a367-40a7-abad-cd0f59bd0778", "name": "List the loaded taxonomies", "request": { "name": "List the loaded taxonomies", "description": { "content": "Every taxonomy this deployment loads, with its business actions and\nresource patterns. Mandates name these actions, and every tool maps\nonto exactly one of them. `package` is the npm package a taxonomy\ncomes from; it is not the taxonomy id with a prefix.\n", "type": "text/plain" }, "url": { "path": [ "taxonomies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ea639bd7-e284-49cf-a93f-f8572a4da505", "name": "Loaded taxonomies, sorted by id", "originalRequest": { "url": { "path": [ "taxonomies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"taxonomies\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"risk_level\": \"LOW\",\n \"requires_human_approval\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"parent_action\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"risk_level\": \"MEDIUM\",\n \"requires_human_approval\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"parent_action\": \"\"\n }\n ],\n \"resource_patterns\": [\n {\n \"name\": \"\",\n \"pattern\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"pattern\": \"\",\n \"description\": \"\"\n }\n ],\n \"package\": \"\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"actions\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"risk_level\": \"MEDIUM\",\n \"requires_human_approval\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"parent_action\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"risk_level\": \"MEDIUM\",\n \"requires_human_approval\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"parent_action\": \"\"\n }\n ],\n \"resource_patterns\": [\n {\n \"name\": \"\",\n \"pattern\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"pattern\": \"\",\n \"description\": \"\"\n }\n ],\n \"package\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afca5ad0-c6d8-447f-8ee7-55abe543308d", "name": "Authentication required", "originalRequest": { "url": { "path": [ "taxonomies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "tools", "description": "", "item": [ { "id": "8bcf14cb-d887-4563-aa2e-ebf634074a7e", "name": "List the tool registry", "request": { "name": "List the tool registry", "description": { "content": "Every version of every tool definition. A tool is one operation on one\nkind of system, mapped to one business action. Definitions are code\nand change only through release; tenants enable a version on one of\ntheir connectors with `PUT /tenants/{id}/tools/{toolId}`.\n\nA tool is `available` when a loaded taxonomy defines its business\naction. An unavailable tool cannot be enabled.\n", "type": "text/plain" }, "url": { "path": [ "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4a52f5d2-01de-43df-96be-03b8414f883a", "name": "Every tool definition version", "originalRequest": { "url": { "path": [ "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tools\": [\n {\n \"id\": \"\",\n \"version\": \"\",\n \"title\": \"\",\n \"business_action\": \"\",\n \"resource_pattern\": \"\",\n \"connector_type\": \"\",\n \"adapter\": \"\",\n \"effect_class\": \"read\",\n \"identity_modes\": [\n \"service_account\",\n \"service_account\"\n ],\n \"arguments_schema\": {\n \"key_0\": false,\n \"key_1\": 1631.0930952829606,\n \"key_2\": 2497\n },\n \"required_facts\": {\n \"key_0\": {\n \"type\": \"timestamp\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n },\n \"preconditions\": [\n {\n \"fact\": \"\",\n \"equals\": \"\"\n },\n {\n \"fact\": \"\",\n \"equals\": \"\"\n }\n ],\n \"returnable_result\": [\n \"\",\n \"\"\n ],\n \"max_approval_window_seconds\": \"\",\n \"available\": \"\",\n \"unavailable_reason\": \"BUSINESS_ACTION_UNKNOWN\"\n },\n {\n \"id\": \"\",\n \"version\": \"\",\n \"title\": \"\",\n \"business_action\": \"\",\n \"resource_pattern\": \"\",\n \"connector_type\": \"\",\n \"adapter\": \"\",\n \"effect_class\": \"read\",\n \"identity_modes\": [\n \"service_account\",\n \"service_account\"\n ],\n \"arguments_schema\": {\n \"key_0\": 4957.699170474004\n },\n \"required_facts\": {\n \"key_0\": {\n \"type\": \"string\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n \"key_1\": {\n \"type\": \"string\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n },\n \"preconditions\": [\n {\n \"fact\": \"\",\n \"equals\": \"\"\n },\n {\n \"fact\": \"\",\n \"equals\": \"\"\n }\n ],\n \"returnable_result\": [\n \"\",\n \"\"\n ],\n \"max_approval_window_seconds\": \"\",\n \"available\": \"\",\n \"unavailable_reason\": \"BUSINESS_ACTION_UNKNOWN\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c58ad778-c66b-404a-8d9b-da66c6e1bec4", "name": "Authentication required", "originalRequest": { "url": { "path": [ "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "executions", "description": "", "item": [ { "id": "b12e8d07-860a-4470-a18f-5ef2f9eebe28", "name": "Request an execution", "request": { "name": "Request an execution", "description": { "content": "An agent asks Mandaitor to perform one typed business operation, sent as\na `mandaitor.tool-request/v1`. The agent names the tool and the record\n(`arguments`, identifiers only). The facts a decision turns on, such as\nthe amount or the plant, are read from the target system, never taken\nfrom the agent.\n\nAuthenticated with the agent's session token from `POST /mcp/token`,\nbound to the agent's key, and nothing else: `Authorization: DPoP mcp_…`\nwith a fresh `DPoP` proof for this request (`McpSessionDPoP`). A bearer\nsession, API keys, user tokens, PoMs and consent ids are refused with\n401. Each agent may send at most 30 requests a minute (429\n`RATE_LIMITED`).\n\n**Idempotency.** `(tenant, agent, idempotency_key)` names at most one\nexecution, until 24 hours after it reaches a final state.\n- A repeat of the same request returns that execution (200).\n- The same key with a different request is 409 `IDEMPOTENCY_CONFLICT`.\n- A repeat while the first is still being decided is 409\n `IDEMPOTENCY_IN_PROGRESS`, naming the execution. Retry after\n `Retry-After`.\n\n`purpose` and `mandate_id` are not part of what makes two requests the\nsame.\n\n**A denial is not an error.** It is 201 with the execution in `DENIED`,\nrecorded on the audit chain before it is returned. When the audit\nevent cannot be written, nothing is created and the answer is 503\n`AUDIT_UNAVAILABLE`.\n\n**Which mandates count.** The decision reads every `ACTIVE` mandate\nnaming the agent as its delegate, by its DID or its agent id. An\n`ALLOW` mandate counts only if it names the tool's business action\nexactly and was created or approved from a person's session. A\n`DENY` mandate counts whoever made it, and wins. More than 100 such\nmandates is `DENIED` with `TOO_MANY_MANDATES`: the decision never\nrests on part of them. `mandate_id` is a hint, and a hint at a\nmandate that does not count is `DENIED` with `HINT_NOT_COVERING`.\n\n**The record.** The decision reads the record the arguments name from\nthe target system, and decides on its facts: the mandate's limits,\nthresholds and validity, and the tool's preconditions. When the record\ncannot be read, nothing is decided: 503 `TARGET_UNAVAILABLE`.\n\n**An `ALLOW` is answered once it is recorded.** The answer is 201\nwith the execution in `AUTHORIZED_NOT_EXECUTED`, and nothing is\nwritten yet. Mandaitor's worker then takes it from a queue, usually\nwithin seconds: it rechecks it against the mandates and the record as\nthey are now, writes it once, and reads it back. Read the outcome\nwith `GET /executions/{id}`: `SUCCEEDED`, `FAILED`, or `UNKNOWN`\nwhen the target's answer and the read-back leave it open. `DENIED`\nmeans the recheck refused it, and `decision` is then that refusal.\nEvery step is recorded on the audit chain before it is taken, and a\nstep that cannot be recorded is not taken: the execution waits in\n`AUTHORIZED_NOT_EXECUTED`, with nothing written, or in `EXECUTING`,\nand the worker takes it up again.\n\n**An `UNKNOWN` execution is read back again**, a minute later and\nthen less and less often, for about 41 hours. Nothing is ever written\nagain. A read-back that finds the write applied, or proves it absent,\nmakes it `SUCCEEDED` or `FAILED` with a receipt. When none does, it\nstays `UNKNOWN` until a person of the tenant resolves it.\n\n**A decision that needs a person's approval waits for it.** The\nexecution is answered in `AWAITING_APPROVAL`, with nothing written.\n`approval` names the consent in the approver's inbox, the approval\ndigest the approver must send back, and when the approval expires (24\nhours at most, never past the mandate's own expiry). The approver\ndecides it with `POST /executions/{id}/approval`, and an approved\nexecution is then rechecked, written and read back by the worker. An approval that\nexpires undecided ends the execution in `DENIED` with\n`APPROVAL_EXPIRED`. An agent may raise 20 approval requests a day;\npast that a decision that needs one is `DENIED` with\n`APPROVAL_LIMIT_REACHED`: the excess is refused, not queued.\n\n**Phase 1.** Executions run only against Mandaitor's hosted sandboxes:\na tool whose connector points elsewhere is `DENIED` with\n`CONNECTOR_NOT_PERMITTED`.\n", "type": "text/plain" }, "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d622feac-d4ce-4e27-aac2-3f0e654c8b02", "name": "A repeat of an earlier request; its execution in its current state", "originalRequest": { "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_EG6LDQ5KJH7JPXYUJSCP0FJG5Q\",\n \"state\": \"EXECUTING\",\n \"state_reason\": \"APPROVED\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:yRbvHgI__DkNLIGSpO8Iota30rNgWLOEe33BsNrV_3o\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"ALLOW\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:iimVwxgA0502j-05VGaYYJ3om9ji9Ms5lD_JOTX_AMB\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf98de66-25db-41f1-b3ad-a9d719255277", "name": "Created, in the state the decision put it: `DENIED`,\n`AWAITING_APPROVAL`, or `AUTHORIZED_NOT_EXECUTED` for an ALLOW\nthe worker writes next.", "originalRequest": { "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_EG6LDQ5KJH7JPXYUJSCP0FJG5Q\",\n \"state\": \"EXECUTING\",\n \"state_reason\": \"APPROVED\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:yRbvHgI__DkNLIGSpO8Iota30rNgWLOEe33BsNrV_3o\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"ALLOW\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:iimVwxgA0502j-05VGaYYJ3om9ji9Ms5lD_JOTX_AMB\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fd689a5-2cc1-4412-8372-2892b01b7947", "name": "`INVALID_REQUEST`: the envelope is not a valid\n`mandaitor.tool-request/v1` (an unknown key, another `contract`,\n`on_behalf_of`). `INVALID_ARGUMENTS`: `arguments` do not match the\ntool's `arguments_schema`. `errors` lists each problem.", "originalRequest": { "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99672a60-e1ae-4c41-9a5d-67faf5b8fef8", "name": "`invalid_token`: no agent session token, a bearer one, or one that\nhas expired or ended because its agent was suspended or revoked.\n`invalid_dpop_proof`: no proof, more than one, or one that is not\nfor this request and this token, is not signed by the session's\nkey, is outside its window, or was used before.", "originalRequest": { "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "`DPoP algs=\"ES256 ES384\", error=\"…\", error_description=\"…\"`", "type": "text/plain" }, "key": "WWW-Authenticate", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a484813c-eacd-408c-8a03-a0319e1c5a01", "name": "`TOOL_NOT_ENABLED`: the tool is unknown, not enabled for the tenant,\npinned to a version other than the enabled one, or cannot run on its\nconnector. These cases share one answer, so the response does not\nreveal which tools exist.", "originalRequest": { "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98d058fb-21d9-4a25-8964-d5bc56c3d90d", "name": "`IDEMPOTENCY_CONFLICT`: the key names a different request.\n`IDEMPOTENCY_IN_PROGRESS`: the key's request is still being decided;\n`execution_id` names it. Retry after `Retry-After`.", "originalRequest": { "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "175b72a7-29c5-4c67-80d9-6fcd01d3689d", "name": "`RATE_LIMITED`: more than 30 requests by this agent in the current minute", "originalRequest": { "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0229de58-05ae-4a3f-b92e-3afc82fafe79", "name": "`AUDIT_UNAVAILABLE`: the decision could not be recorded on the audit\nchain, so no execution was created. `TARGET_UNAVAILABLE`: the record\ncould not be read from the target system, so nothing was decided.\nEither way, retry after `Retry-After`, with the same idempotency\nkey.", "originalRequest": { "url": { "path": [ "executions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contract\": \"mandaitor.tool-request/v1\",\n \"tool\": \"\",\n \"arguments\": {\n \"key_0\": 9297.067669843713,\n \"key_1\": \"string\"\n },\n \"idempotency_key\": \"+>1(|cqhxwWW_`#?&P%k^_1%Y87pw!Ar>dy(7~i5XD&B;Lok!11T^+cChg\",\n \"tool_version\": \"\",\n \"mandate_id\": \"mdt_1zxIvbIFQGQxq1graq6VE\",\n \"purpose\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "a37db822-f7a5-4453-8f6f-79b7d788bc8b", "name": "Read one of the agent's executions", "request": { "name": "Read one of the agent's executions", "description": { "content": "Authenticated like `POST /executions`. An agent reads only its own\nexecutions; another agent's or another tenant's execution is 404, as is\nan id that does not exist. An execution whose approval expired\nundecided is answered, and recorded, as `DENIED` with\n`APPROVAL_EXPIRED`.\n\nThis is how an agent learns the outcome of what it asked for: read\nit until it is final (`DENIED`, `SUCCEEDED`, `FAILED`) or waits for\nan approval. A few seconds between reads is enough; the SDK's\n`waitForExecution` does it.\n", "type": "text/plain" }, "url": { "path": [ "executions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0b91b59e-629c-4066-81db-bacd38ac0af7", "name": "The execution", "originalRequest": { "url": { "path": [ "executions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_EG6LDQ5KJH7JPXYUJSCP0FJG5Q\",\n \"state\": \"EXECUTING\",\n \"state_reason\": \"APPROVED\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:yRbvHgI__DkNLIGSpO8Iota30rNgWLOEe33BsNrV_3o\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"ALLOW\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:iimVwxgA0502j-05VGaYYJ3om9ji9Ms5lD_JOTX_AMB\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cd86145-e9f6-4344-b7fd-8c65c298c5a3", "name": "`invalid_token` or `invalid_dpop_proof`, as for `POST /executions`", "originalRequest": { "url": { "path": [ "executions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "`DPoP algs=\"ES256 ES384\", error=\"…\", error_description=\"…\"`", "type": "text/plain" }, "key": "WWW-Authenticate", "value": "" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70169450-1f5c-4668-a8ca-7f411d566551", "name": "`EXECUTION_NOT_FOUND`", "originalRequest": { "url": { "path": [ "executions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) A fresh DPoP proof (RFC 9449) for this request and this session\ntoken, signed by the key the session is bound to (`McpSessionDPoP`).\n", "type": "text/plain" }, "key": "DPoP", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "approval", "description": "", "item": [ { "id": "9dd3d65d-9c38-4ae1-9990-5967dbce4352", "name": "Approve or reject an execution that waits for your approval", "request": { "name": "Approve or reject an execution that waits for your approval", "description": { "content": "The person an execution's approval names decides it. Only a person's\nsession is accepted: a dashboard session, or one from the tenant's\nown identity provider. An API key or an agent is refused with 403\n`NOT_A_PERSON`, and anyone the approval does not name with 403\n`NOT_THE_APPROVER`. When the mandate requires MFA, the session must\nhave been signed in with it: every dashboard session is, and a\nsession from the tenant's identity provider is when its token's\n`amr` says `mfa` (403 `MFA_REQUIRED` otherwise).\n\n**To approve**, send the `approval_digest` you were shown. The\napproval is granted only when it equals the digest the approval was\nraised with and one computed again from a fresh read of the record,\nunder the mandates and the execution policy as they are now. The\nanswer is the execution in `AUTHORIZED_NOT_EXECUTED`, approved.\nMandaitor's worker then rechecks it, writes it once and reads it\nback, as for a decision that needs no approval; the dashboard and\n`GET /tenants/{id}/executions/{executionId}` show the outcome.\n\n**When something changed**, nothing is written:\n- The record, the mandates or the policy changed since the approval\n was raised, and the decision still needs an approval: a new one is\n raised, with its own consent and digest, and the answer is 409\n `DIGEST_MISMATCH` carrying the execution with it.\n- The record changed so that it no longer needs an approval: the\n execution is `DENIED` with `RECORD_CHANGED`, and the agent asks\n again (409 `DIGEST_MISMATCH`).\n- The decision on the record as it is now is a denial, the mandate\n is no longer in force, the agent no longer active, or the tool no\n longer enabled: the execution is `DENIED` (409 `EXECUTION_DENIED`).\n\n**To reject**, send `REJECT`; no digest is needed. The execution is\n`DENIED` with `APPROVAL_REJECTED`.\n\nAn approval is decided once. A second, concurrent decision is\nrefused with 409 `APPROVAL_IN_PROGRESS` before it records anything.\n", "type": "text/plain" }, "url": { "path": [ "executions", ":id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVE\",\n \"approval_digest\": \"sha-256:X41x8aGDq5wHPC9bX9VFGOoJT-OiytX20lt7n_vdGBe\",\n \"consent_id\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "20ed7a4f-7495-448f-bd51-5294b0eb51bb", "name": "Decided: rejected, or approved and queued for the worker to\nwrite. The execution as it is now.", "originalRequest": { "url": { "path": [ "executions", ":id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVE\",\n \"approval_digest\": \"sha-256:X41x8aGDq5wHPC9bX9VFGOoJT-OiytX20lt7n_vdGBe\",\n \"consent_id\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_EG6LDQ5KJH7JPXYUJSCP0FJG5Q\",\n \"state\": \"EXECUTING\",\n \"state_reason\": \"APPROVED\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:yRbvHgI__DkNLIGSpO8Iota30rNgWLOEe33BsNrV_3o\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"ALLOW\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:iimVwxgA0502j-05VGaYYJ3om9ji9Ms5lD_JOTX_AMB\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66dd9ea6-a667-4f76-9eae-f6e4720de2a5", "name": "`INVALID_REQUEST`: not a valid decision; `errors` lists each problem.", "originalRequest": { "url": { "path": [ "executions", ":id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVE\",\n \"approval_digest\": \"sha-256:X41x8aGDq5wHPC9bX9VFGOoJT-OiytX20lt7n_vdGBe\",\n \"consent_id\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dc82df0-0f4a-498d-a75d-7c1f2fd377a6", "name": "Missing or invalid credentials, refused by the gateway", "originalRequest": { "url": { "path": [ "executions", ":id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVE\",\n \"approval_digest\": \"sha-256:X41x8aGDq5wHPC9bX9VFGOoJT-OiytX20lt7n_vdGBe\",\n \"consent_id\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7821ecea-4341-47b2-9b34-5dce4566ab92", "name": "`NOT_A_PERSON`, `NOT_THE_APPROVER` or `MFA_REQUIRED`. Nothing\nabout the execution is shown.", "originalRequest": { "url": { "path": [ "executions", ":id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVE\",\n \"approval_digest\": \"sha-256:X41x8aGDq5wHPC9bX9VFGOoJT-OiytX20lt7n_vdGBe\",\n \"consent_id\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d2e8bf7-76c9-4f1b-9dcd-6c01768bddca", "name": "`EXECUTION_NOT_FOUND`: no such execution in the caller's tenant", "originalRequest": { "url": { "path": [ "executions", ":id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVE\",\n \"approval_digest\": \"sha-256:X41x8aGDq5wHPC9bX9VFGOoJT-OiytX20lt7n_vdGBe\",\n \"consent_id\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b48ca82-3726-4eb7-b803-12ee9ae34872", "name": "Nothing was approved. `execution` is the execution as it is now,\nfor the approver.\n- `DIGEST_MISMATCH`: the digest sent is not the approval's, or\n what it covered changed (see above).\n- `APPROVAL_SUPERSEDED`: `consent_id` names an approval a newer\n one replaced.\n- `APPROVAL_EXPIRED`: it expired undecided; the execution is now\n `DENIED`.\n- `EXECUTION_DENIED`: denied as described above.\n- `NOT_AWAITING_APPROVAL`: the execution is not waiting for an\n approval, for instance because it was already decided.\n- `APPROVAL_IN_PROGRESS`: another decision on it is under way.\n- `TOOL_NOT_ENABLED`: its tool version is no longer defined.", "originalRequest": { "url": { "path": [ "executions", ":id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVE\",\n \"approval_digest\": \"sha-256:X41x8aGDq5wHPC9bX9VFGOoJT-OiytX20lt7n_vdGBe\",\n \"consent_id\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28289815-31ed-478a-93f3-1df852b39c5d", "name": "`TARGET_UNAVAILABLE`: the record could not be read to check it,\nso nothing was approved. `AUDIT_UNAVAILABLE`: the decision could\nnot be recorded on the audit chain, so nothing changed. Retry.", "originalRequest": { "url": { "path": [ "executions", ":id", "approval" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "exe_GV5VBA3ZQB3MLPYUXXKDHY2JSX", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"decision\": \"APPROVE\",\n \"approval_digest\": \"sha-256:X41x8aGDq5wHPC9bX9VFGOoJT-OiytX20lt7n_vdGBe\",\n \"consent_id\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"path\": \"\",\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"execution_id\": \"\",\n \"execution\": {\n \"contract\": \"mandaitor.execution/v1\",\n \"execution_id\": \"exe_PKHOIJOX6CRPB39KC2BTEV09TW\",\n \"state\": \"AWAITING_APPROVAL\",\n \"state_reason\": \"INDETERMINATE\",\n \"tool\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"request_digest\": \"sha-256:kc_tNqKbnpQu8QN3T85LZeJqejp1NbsaBPT7Yebell5\",\n \"decision\": {\n \"event_id\": \"\",\n \"outcome\": \"REQUIRE_APPROVAL\",\n \"reason\": \"\",\n \"mandate_id\": \"\"\n },\n \"approval\": {\n \"consent_id\": \"\",\n \"digest\": \"sha-256:EvgL_GeAFIAYM6hIh2RkF_TI6HbMVNNNPo8LYHgkVHg\",\n \"expires_at\": \"\",\n \"approved_at\": \"\"\n },\n \"result\": {},\n \"receipt\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "marketplace", "description": "", "item": [ { "name": "listings", "description": "", "item": [ { "id": "7c7be800-963f-4b36-951d-5a70316f4c52", "name": "Create a new marketplace listing", "request": { "name": "Create a new marketplace listing", "description": {}, "url": { "path": [ "marketplace", "listings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": \"\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"DOCUMENT_PROCESSING\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"CUSTOM\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1ca09e25-5de0-4bcb-9fdf-9832d91109d6", "name": "Listing created", "originalRequest": { "url": { "path": [ "marketplace", "listings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": \"\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"DOCUMENT_PROCESSING\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"CUSTOM\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"PUBLISHED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"COMPLIANCE\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"INTEGRATION\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_MINUTE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fbba023-4c21-45fc-ad5a-e02b1c79b0ce", "name": "Validation error", "originalRequest": { "url": { "path": [ "marketplace", "listings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": \"\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"DOCUMENT_PROCESSING\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"CUSTOM\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f200e698-2f6e-415a-aca5-eabd5491861f", "name": "List own marketplace listings", "request": { "name": "List own marketplace listings", "description": {}, "url": { "path": [ "marketplace", "listings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7c470a3c-630a-46b9-ab00-dc901b47d6f0", "name": "Paginated list of own listings", "originalRequest": { "url": { "path": [ "marketplace", "listings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"ARCHIVED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"FINANCIAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"IDENTITY\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"FREE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n },\n {\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"ARCHIVED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"LEGAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"DATA_ANALYSIS\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_MINUTE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"total_count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a93c2ef-1b31-4bbe-bfe6-b58894de0670", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "marketplace", "listings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{listingId}", "description": "", "item": [ { "id": "1dc35ee8-5cb8-4e49-b2ad-b79d4f376467", "name": "Get listing details", "request": { "name": "Get listing details", "description": {}, "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "listingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "34ce7e06-09b7-430e-b14e-73563917a482", "name": "Listing details", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"PUBLISHED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"COMPLIANCE\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"INTEGRATION\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_MINUTE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "796eedae-d477-43b0-99eb-d892f7d8a65d", "name": "Listing not found", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "934348b5-3ffd-40ac-b925-2927a0f21cd7", "name": "Update listing", "request": { "name": "Update listing", "description": {}, "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "listingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"FINANCIAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"DOCUMENT_PROCESSING\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_CALL\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ba8dc72c-f921-401e-bd19-af84f2b47289", "name": "Listing updated", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"FINANCIAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"DOCUMENT_PROCESSING\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_CALL\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"PUBLISHED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"COMPLIANCE\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"INTEGRATION\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_MINUTE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d564d83e-db06-4b3d-bd30-9437f50e71c2", "name": "Not the listing owner", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"FINANCIAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"DOCUMENT_PROCESSING\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_CALL\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d78217f5-da00-4dde-a5b0-958081588b60", "name": "Archive listing (soft-delete)", "request": { "name": "Archive listing (soft-delete)", "description": {}, "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "listingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e140343b-1b51-4fd5-9535-6b8cb2a11731", "name": "Listing archived", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "737507da-bdae-4f1a-8d2c-0373f6806d97", "name": "Not the listing owner", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "publish", "description": "", "item": [ { "id": "f964a2a8-dc4e-4462-beb3-8c1f157ec27d", "name": "Publish a draft listing", "request": { "name": "Publish a draft listing", "description": {}, "url": { "path": [ "marketplace", "listings", ":listingId", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "listingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4b979eff-9d46-4464-9c0e-d61555b04dcc", "name": "Listing published", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"PUBLISHED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"COMPLIANCE\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"INTEGRATION\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_MINUTE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f307c817-49fb-4330-8ba5-799cbdffa9d9", "name": "Listing not in DRAFT status", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "suspend", "description": "", "item": [ { "id": "990f57cd-46f2-4b89-8e36-ae17ed750c64", "name": "Suspend a published listing", "request": { "name": "Suspend a published listing", "description": {}, "url": { "path": [ "marketplace", "listings", ":listingId", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "listingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8dc8c44d-81b8-4c46-b91c-b216947ec2bb", "name": "Listing suspended", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"PUBLISHED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"COMPLIANCE\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"INTEGRATION\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"PER_MINUTE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79b94574-82db-44f9-8e50-f959c0cd4ba6", "name": "Listing not in PUBLISHED status", "originalRequest": { "url": { "path": [ "marketplace", "listings", ":listingId", "suspend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "discover", "description": "", "item": [ { "id": "05865a2c-0446-4aa6-b205-4e796ec22472", "name": "Discover agents (public)", "request": { "name": "Discover agents (public)", "description": {}, "url": { "path": [ "marketplace", "discover" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of DOCUMENT_PROCESSING,DATA_ANALYSIS,COMMUNICATION,FINANCIAL,LEGAL,COMPLIANCE,IDENTITY,INTEGRATION,AUTOMATION,CUSTOM)", "type": "text/plain" }, "key": "category", "value": "FINANCIAL" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_trust_score", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_rating", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of FREE,PER_CALL,PER_MINUTE,MONTHLY,CUSTOM)", "type": "text/plain" }, "key": "pricing_model", "value": "PER_MINUTE" }, { "disabled": false, "description": { "content": " (This can only be one of trust_score,rating,invocations,response_time,created_at)", "type": "text/plain" }, "key": "sort_by", "value": "rating" }, { "disabled": false, "description": { "content": " (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "97019529-2df9-41c9-a42f-aae71373fa8b", "name": "Discovery results", "originalRequest": { "url": { "path": [ "marketplace", "discover" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of DOCUMENT_PROCESSING,DATA_ANALYSIS,COMMUNICATION,FINANCIAL,LEGAL,COMPLIANCE,IDENTITY,INTEGRATION,AUTOMATION,CUSTOM)", "type": "text/plain" }, "key": "category", "value": "FINANCIAL" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_trust_score", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_rating", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of FREE,PER_CALL,PER_MINUTE,MONTHLY,CUSTOM)", "type": "text/plain" }, "key": "pricing_model", "value": "PER_MINUTE" }, { "disabled": false, "description": { "content": " (This can only be one of trust_score,rating,invocations,response_time,created_at)", "type": "text/plain" }, "key": "sort_by", "value": "rating" }, { "disabled": false, "description": { "content": " (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"listings\": [\n {\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"PUBLISHED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"FINANCIAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"AUTOMATION\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"CUSTOM\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n },\n {\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"ARCHIVED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"LEGAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"CUSTOM\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"FREE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93586049-9c1f-4e85-8b9a-673f23b1b0f0", "name": "Invalid query parameters", "originalRequest": { "url": { "path": [ "marketplace", "discover" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Free-text search", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of DOCUMENT_PROCESSING,DATA_ANALYSIS,COMMUNICATION,FINANCIAL,LEGAL,COMPLIANCE,IDENTITY,INTEGRATION,AUTOMATION,CUSTOM)", "type": "text/plain" }, "key": "category", "value": "FINANCIAL" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_trust_score", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "min_rating", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of FREE,PER_CALL,PER_MINUTE,MONTHLY,CUSTOM)", "type": "text/plain" }, "key": "pricing_model", "value": "PER_MINUTE" }, { "disabled": false, "description": { "content": " (This can only be one of trust_score,rating,invocations,response_time,created_at)", "type": "text/plain" }, "key": "sort_by", "value": "rating" }, { "disabled": false, "description": { "content": " (This can only be one of asc,desc)", "type": "text/plain" }, "key": "sort_order", "value": "desc" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "match", "description": "", "item": [ { "id": "772ecc23-5e00-40c2-9c67-f21f93e1afb2", "name": "Find best-matching agents for a task", "request": { "name": "Find best-matching agents for a task", "description": {}, "url": { "path": [ "marketplace", "discover", "match" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_description\": \"\",\n \"required_capabilities\": [\n \"\",\n \"\"\n ],\n \"max_results\": 5\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1ab75299-c039-4e78-a27c-b2d79e128230", "name": "Matched agents ranked by relevance", "originalRequest": { "url": { "path": [ "marketplace", "discover", "match" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_description\": \"\",\n \"required_capabilities\": [\n \"\",\n \"\"\n ],\n \"max_results\": 5\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"listings\": [\n {\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"PUBLISHED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"FINANCIAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"AUTOMATION\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"CUSTOM\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n },\n {\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"owner_tenant_id\": \"\",\n \"status\": \"ARCHIVED\",\n \"display_name\": \"\",\n \"tagline\": \"\",\n \"description\": \"\",\n \"capabilities\": [\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"LEGAL\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n },\n {\n \"capability_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"CUSTOM\",\n \"required_scopes\": [\n \"\",\n \"\"\n ],\n \"input_schema\": {},\n \"output_schema\": {},\n \"avg_execution_ms\": \"\",\n \"max_execution_ms\": \"\"\n }\n ],\n \"pricing\": {\n \"model\": \"FREE\",\n \"unit_price\": \"\",\n \"currency\": \"\",\n \"free_tier_limit\": \"\",\n \"custom_description\": \"\"\n },\n \"trust_metrics\": {\n \"trust_score\": \"\",\n \"avg_rating\": \"\",\n \"review_count\": \"\",\n \"total_invocations\": \"\",\n \"success_rate\": \"\",\n \"avg_response_ms\": \"\",\n \"drift_score\": \"\",\n \"uptime\": \"\",\n \"computed_at\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"logo_url\": \"\",\n \"docs_url\": \"\",\n \"supported_regions\": [\n \"\",\n \"\"\n ],\n \"certifications\": [\n \"\",\n \"\"\n ],\n \"published_at\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c72c59a-ea96-4d2b-977c-49c04467d83e", "name": "Missing required field (capability_id)", "originalRequest": { "url": { "path": [ "marketplace", "discover", "match" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_description\": \"\",\n \"required_capabilities\": [\n \"\",\n \"\"\n ],\n \"max_results\": 5\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "reviews", "description": "", "item": [ { "id": "d6768765-9f48-48c7-929f-50e49e15862e", "name": "Submit a review", "request": { "name": "Submit a review", "description": {}, "url": { "path": [ "marketplace", "reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listing_id\": \"\",\n \"rating\": \"\",\n \"comment\": \"\",\n \"capability_id\": \"\",\n \"consent_request_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bd9b5b76-7166-4406-8365-6ac69b18cad8", "name": "Review created", "originalRequest": { "url": { "path": [ "marketplace", "reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listing_id\": \"\",\n \"rating\": \"\",\n \"comment\": \"\",\n \"capability_id\": \"\",\n \"consent_request_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"review_id\": \"\",\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"reviewer_tenant_id\": \"\",\n \"rating\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"comment\": \"\",\n \"capability_id\": \"\",\n \"consent_request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fd736fa-995e-4985-b9be-988c70bd8cc6", "name": "Validation error", "originalRequest": { "url": { "path": [ "marketplace", "reviews" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"listing_id\": \"\",\n \"rating\": \"\",\n \"comment\": \"\",\n \"capability_id\": \"\",\n \"consent_request_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{listingId}", "description": "", "item": [ { "id": "d0051109-a8a0-4661-847a-bb8363759d3a", "name": "List reviews for a listing (public)", "request": { "name": "List reviews for a listing (public)", "description": {}, "url": { "path": [ "marketplace", "reviews", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [ { "type": "any", "value": "", "key": "listingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6d9e64b1-a2bb-480c-8392-a5c0fa5f63a2", "name": "Paginated reviews", "originalRequest": { "url": { "path": [ "marketplace", "reviews", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"review_id\": \"\",\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"reviewer_tenant_id\": \"\",\n \"rating\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"comment\": \"\",\n \"capability_id\": \"\",\n \"consent_request_id\": \"\"\n },\n {\n \"review_id\": \"\",\n \"listing_id\": \"\",\n \"agent_id\": \"\",\n \"reviewer_tenant_id\": \"\",\n \"rating\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"comment\": \"\",\n \"capability_id\": \"\",\n \"consent_request_id\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"total_count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e094114-1ec4-4225-83e3-325344212fd5", "name": "Missing listingId", "originalRequest": { "url": { "path": [ "marketplace", "reviews", ":listingId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{reviewId}", "description": "", "item": [ { "id": "8ab0dbd6-68e6-4469-a725-0468bd96a264", "name": "Delete own review", "request": { "name": "Delete own review", "description": {}, "url": { "path": [ "marketplace", "reviews", ":listingId", ":reviewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "listingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "reviewId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f47df3d0-ddfc-4212-8bba-e8ab0783bceb", "name": "Review deleted", "originalRequest": { "url": { "path": [ "marketplace", "reviews", ":listingId", ":reviewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "reviewId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54473edb-c045-45de-bc61-5c2c9134223e", "name": "Not the review author", "originalRequest": { "url": { "path": [ "marketplace", "reviews", ":listingId", ":reviewId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "listingId" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "reviewId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "partner", "description": "", "item": [ { "name": "media", "description": "", "item": [ { "name": "assets", "description": "", "item": [ { "id": "ddcc77d9-306f-42e6-bf15-08f4d44d296f", "name": "List knowledge assets", "request": { "name": "List knowledge assets", "description": {}, "url": { "path": [ "partner", "media", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of public,partner-confidential,client-confidential,internal-restricted)", "type": "text/plain" }, "key": "classification", "value": "client-confidential" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "lifecycle_area", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of planned,draft,release-candidate,approved,uploaded,superseded,archived,withdrawn)", "type": "text/plain" }, "key": "status", "value": "uploaded" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9ca9606a-bd68-4629-9c08-686be864a776", "name": "Knowledge assets visible to the caller", "originalRequest": { "url": { "path": [ "partner", "media", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of public,partner-confidential,client-confidential,internal-restricted)", "type": "text/plain" }, "key": "classification", "value": "client-confidential" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "lifecycle_area", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of planned,draft,release-candidate,approved,uploaded,superseded,archived,withdrawn)", "type": "text/plain" }, "key": "status", "value": "uploaded" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"uploaded\",\n \"classification\": \"client-confidential\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"withdrawn\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82a02343-72f9-41a3-b0e5-49e68497cc3c", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "media", "assets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of public,partner-confidential,client-confidential,internal-restricted)", "type": "text/plain" }, "key": "classification", "value": "client-confidential" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "lifecycle_area", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of planned,draft,release-candidate,approved,uploaded,superseded,archived,withdrawn)", "type": "text/plain" }, "key": "status", "value": "uploaded" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43495d9c-5b3d-4fce-85de-b36e82881f89", "name": "Create or update a knowledge asset (expert catalog form)", "request": { "name": "Create or update a knowledge asset (expert catalog form)", "description": {}, "url": { "path": [ "partner", "media", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"asset_id\": \"\",\n \"status\": \"planned\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"manifest_path\": \"\",\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"review_notes\": \"\",\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ca1adf43-3473-4375-a6a7-7383bc58693f", "name": "Existing asset updated", "originalRequest": { "url": { "path": [ "partner", "media", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"asset_id\": \"\",\n \"status\": \"planned\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"manifest_path\": \"\",\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"review_notes\": \"\",\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"asset\": {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"planned\",\n \"classification\": \"internal-restricted\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24c2113a-47f0-4a82-bd72-0ec41a845c8b", "name": "Asset created", "originalRequest": { "url": { "path": [ "partner", "media", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"asset_id\": \"\",\n \"status\": \"planned\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"manifest_path\": \"\",\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"review_notes\": \"\",\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"asset\": {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"planned\",\n \"classification\": \"internal-restricted\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a15d6685-4b10-43bf-9d3a-86065d437fb6", "name": "Invalid request", "originalRequest": { "url": { "path": [ "partner", "media", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"asset_id\": \"\",\n \"status\": \"planned\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"manifest_path\": \"\",\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"review_notes\": \"\",\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ae476b4-eabb-4542-8088-88e08270e1a3", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "media", "assets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"asset_id\": \"\",\n \"status\": \"planned\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"manifest_path\": \"\",\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"review_notes\": \"\",\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "publish", "description": "", "item": [ { "id": "2d9d51a4-77fe-423d-b86e-a7ba7700ae31", "name": "One-shot document publish (simplified flow)", "request": { "name": "One-shot document publish (simplified flow)", "description": { "content": "Creates a single-file document asset from a title + file metadata,\nderiving all catalog fields server-side, and returns a presigned S3\nPUT for the bytes. Send the returned `upload_headers` verbatim with\nthe PUT — when a `sha256` was announced, the checksum header is part\nof the signature and S3 rejects non-matching bytes. Finish with\n`publish-complete`.\n", "type": "text/plain" }, "url": { "path": [ "partner", "media", "assets", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"file_name\": \"\",\n \"size_bytes\": \"\",\n \"content_type\": \"application/octet-stream\",\n \"sha256\": \"\",\n \"classification\": \"internal-restricted\",\n \"engagement_id\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9b1a9ff0-799f-4da3-9075-2c6d2b144e8f", "name": "Document registered; upload the bytes next", "originalRequest": { "url": { "path": [ "partner", "media", "assets", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"file_name\": \"\",\n \"size_bytes\": \"\",\n \"content_type\": \"application/octet-stream\",\n \"sha256\": \"\",\n \"classification\": \"internal-restricted\",\n \"engagement_id\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"asset\": {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"withdrawn\",\n \"classification\": \"client-confidential\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"version\": {\n \"version_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"status\": \"uploaded\",\n \"classification\": \"internal-restricted\",\n \"storage_bucket_env\": \"\",\n \"storage_bucket\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"source_commit\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"manifest-supporting\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"other\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n }\n ]\n },\n \"file\": {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"transcript\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n \"upload_url\": \"\",\n \"upload_expires_in\": \"\",\n \"upload_headers\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72405f42-b298-425f-9adb-3618a38c7ece", "name": "Invalid request", "originalRequest": { "url": { "path": [ "partner", "media", "assets", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"file_name\": \"\",\n \"size_bytes\": \"\",\n \"content_type\": \"application/octet-stream\",\n \"sha256\": \"\",\n \"classification\": \"internal-restricted\",\n \"engagement_id\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be50cbe0-6ef9-46e4-b215-0a1fb3ab5432", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "media", "assets", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"file_name\": \"\",\n \"size_bytes\": \"\",\n \"content_type\": \"application/octet-stream\",\n \"sha256\": \"\",\n \"classification\": \"internal-restricted\",\n \"engagement_id\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{assetId}", "description": "", "item": [ { "id": "5d1b0d6e-1c4e-4ff3-8468-bbb58eeef300", "name": "Get a knowledge asset with its versions and files", "request": { "name": "Get a knowledge asset with its versions and files", "description": {}, "url": { "path": [ "partner", "media", "assets", ":assetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "assetId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "76a9cb52-7a56-4008-8d85-0d5e145b09eb", "name": "Asset detail", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"asset\": {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"release-candidate\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"versions\": [\n {\n \"version_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"status\": \"approved\",\n \"classification\": \"partner-confidential\",\n \"storage_bucket_env\": \"\",\n \"storage_bucket\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"source_commit\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"other\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"thumbnail\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n }\n ]\n },\n {\n \"version_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"status\": \"approved\",\n \"classification\": \"public\",\n \"storage_bucket_env\": \"\",\n \"storage_bucket\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"source_commit\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"thumbnail\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"caption\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34c9e4ed-c947-44f9-af60-73ee62064b92", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1799a343-c44f-4324-8a54-001a68b91691", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "versions", "description": "", "item": [ { "id": "dc74f273-4c33-4b4e-b85a-ad042084ab8b", "name": "Register an immutable media version (expert catalog form)", "request": { "name": "Register an immutable media version (expert catalog form)", "description": { "content": "Version strings are immutable — re-posting an existing one answers\n409. `approved_by`/`approved_at` are set server-side when `status`\nis `approved` and never accepted from the request. The asset's\n`current_version` only advances when the new version is genuinely\nnewer (numeric dotted versions compare numerically).\n", "type": "text/plain" }, "url": { "path": [ "partner", "media", "assets", ":assetId", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "assetId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"status\": \"superseded\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"source_commit\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"role\": \"thumbnail\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n },\n {\n \"file_id\": \"\",\n \"role\": \"other\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "49620155-b9f4-4209-85a4-a2bbb6fefe55", "name": "Version registered", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"status\": \"superseded\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"source_commit\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"role\": \"thumbnail\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n },\n {\n \"file_id\": \"\",\n \"role\": \"other\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"version\": {\n \"version_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"status\": \"uploaded\",\n \"classification\": \"partner-confidential\",\n \"storage_bucket_env\": \"\",\n \"storage_bucket\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"source_commit\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"transcript\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"thumbnail\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34783f3d-5ec0-45ba-b824-ac0683458aec", "name": "Invalid request", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"status\": \"superseded\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"source_commit\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"role\": \"thumbnail\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n },\n {\n \"file_id\": \"\",\n \"role\": \"other\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bb3307d-6a08-423b-bfc7-bee87aa7ec6b", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"status\": \"superseded\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"source_commit\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"role\": \"thumbnail\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n },\n {\n \"file_id\": \"\",\n \"role\": \"other\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adb5b02c-b987-45c9-bf5f-66a42c61766c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"status\": \"superseded\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"source_commit\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"role\": \"thumbnail\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n },\n {\n \"file_id\": \"\",\n \"role\": \"other\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c163a129-ca8e-4919-9410-e4e53b909a3d", "name": "State conflict", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"status\": \"superseded\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"source_commit\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"role\": \"thumbnail\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n },\n {\n \"file_id\": \"\",\n \"role\": \"other\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"language\": \"\",\n \"format\": \"\",\n \"storage_key\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "publish-complete", "description": "", "item": [ { "id": "1569a782-0f75-4af2-b22a-50b58e866df2", "name": "Confirm a document upload landed and publish the asset", "request": { "name": "Confirm a document upload landed and publish the asset", "description": { "content": "Verifies the uploaded object exists (and, when a SHA-256 was\nannounced, that S3's stored checksum matches), records the real\nobject size, and flips the asset and version to `uploaded`.\n", "type": "text/plain" }, "url": { "path": [ "partner", "media", "assets", ":assetId", "publish-complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "assetId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ebae5612-d366-4594-a7b4-3f85408170f7", "name": "Document published", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "publish-complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"asset\": {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"planned\",\n \"classification\": \"partner-confidential\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"version\": {\n \"version_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"status\": \"superseded\",\n \"classification\": \"client-confidential\",\n \"storage_bucket_env\": \"\",\n \"storage_bucket\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"source_commit\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"export\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"source-bundle\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n }\n ]\n },\n \"file\": {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"source-bundle\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b270f76d-3d8e-4cab-8f7e-9f8ce724f6cc", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "publish-complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ced17a61-62dc-48de-aaaf-b6d5036fd8c5", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "publish-complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af764f97-ff55-4fb6-9290-00f719897408", "name": "State conflict", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "publish-complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "files", "description": "", "item": [ { "name": "signed-url", "description": "", "item": [ { "id": "71bd67b2-c935-4e66-9711-28b39e4fbd3b", "name": "Create a short-lived signed download URL for a file", "request": { "name": "Create a short-lived signed download URL for a file", "description": {}, "url": { "path": [ "partner", "media", "assets", ":assetId", "files", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "assetId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bcdd80cc-9920-4b59-9a44-2bac137c5041", "name": "Signed URL issued (download is audited)", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "files", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"signed_url\": \"\",\n \"expires_in\": \"\",\n \"expires_at\": \"\",\n \"file\": {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"other\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n \"asset\": {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"superseded\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"version\": {\n \"version_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"status\": \"draft\",\n \"classification\": \"public\",\n \"storage_bucket_env\": \"\",\n \"storage_bucket\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"source_commit\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"thumbnail\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"other\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c31b7f66-8bb0-4735-b511-dd7e219ccdb4", "name": "Invalid request", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "files", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2c50bc9-7f41-4a52-b50c-5ce64d80bd1c", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "files", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a93c830f-ee1a-4b0f-9ce8-68ab2f670fe3", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "media", "assets", ":assetId", "files", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "assetId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "files", "description": "", "item": [ { "name": "{fileId}", "description": "", "item": [ { "name": "signed-url", "description": "", "item": [ { "id": "bf60308a-8431-454e-8b9f-9704a6400ec1", "name": "Create a signed download URL addressing the file by id", "request": { "name": "Create a signed download URL addressing the file by id", "description": { "content": "Body must carry `asset_id` and `version`; the path's file id overrides any body `file_id`.", "type": "text/plain" }, "url": { "path": [ "partner", "media", "files", ":fileId", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "fileId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6aa61009-8195-4df7-ae6d-0eba1ed8703a", "name": "Signed URL issued (download is audited)", "originalRequest": { "url": { "path": [ "partner", "media", "files", ":fileId", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"signed_url\": \"\",\n \"expires_in\": \"\",\n \"expires_at\": \"\",\n \"file\": {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"other\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n \"asset\": {\n \"asset_id\": \"\",\n \"tenant_id\": \"\",\n \"title\": \"\",\n \"status\": \"superseded\",\n \"classification\": \"public\",\n \"lifecycle_area\": \"\",\n \"lifecycle_phases\": [\n \"\",\n \"\"\n ],\n \"primary_audience\": [\n \"\",\n \"\"\n ],\n \"owner\": \"\",\n \"source_references\": [\n \"\",\n \"\"\n ],\n \"current_version\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_path\": \"\",\n \"review\": {\n \"required_reviewers\": [\n \"\",\n \"\"\n ],\n \"last_reviewed_at\": \"\",\n \"notes\": \"\"\n },\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"version\": {\n \"version_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"status\": \"draft\",\n \"classification\": \"public\",\n \"storage_bucket_env\": \"\",\n \"storage_bucket\": \"\",\n \"storage_prefix\": \"\",\n \"manifest_s3_key\": \"\",\n \"manifest_path\": \"\",\n \"release_notes\": \"\",\n \"supersedes_version\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"source_commit\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"files\": [\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"thumbnail\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n },\n {\n \"file_id\": \"\",\n \"tenant_id\": \"\",\n \"asset_id\": \"\",\n \"version\": \"\",\n \"storage_key\": \"\",\n \"relative_path\": \"\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"size_bytes\": \"\",\n \"sha256\": \"\",\n \"role\": \"other\",\n \"language\": \"\",\n \"format\": \"\",\n \"created_at\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c44ab9b-73c6-4b0a-8d02-4b9874aaa5ab", "name": "Invalid request", "originalRequest": { "url": { "path": [ "partner", "media", "files", ":fileId", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad02f486-41f2-4eea-8da5-9199376e05b2", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "media", "files", ":fileId", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13051e1e-c968-436f-9a9a-d34a511422ed", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "media", "files", ":fileId", "signed-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"file_id\": \"\",\n \"relative_path\": \"\",\n \"asset_id\": \"\",\n \"project_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "projects", "description": "", "item": [ { "name": "{projectId}", "description": "", "item": [ { "name": "artifacts", "description": "", "item": [ { "id": "3a69249a-ac86-4348-a8ec-635f46f74097", "name": "List an engagement's artifacts", "request": { "name": "List an engagement's artifacts", "description": {}, "url": { "path": [ "partner", "projects", ":projectId", "artifacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "projectId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "38a329b7-1bfd-4f79-bbc7-fa3ee2a98a01", "name": "Artifacts authored so far (at most one per type)", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"artifact_id\": \"\",\n \"tenant_id\": \"\",\n \"engagement_id\": \"\",\n \"artifact_type\": \"MANDATE_DESIGN\",\n \"status\": \"DRAFT\",\n \"version\": \"\",\n \"payload\": {\n \"key_0\": true,\n \"key_1\": 2777.370728842292\n },\n \"review_task_id\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_by\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"artifact_id\": \"\",\n \"tenant_id\": \"\",\n \"engagement_id\": \"\",\n \"artifact_type\": \"VERIFICATION_PLAN\",\n \"status\": \"SUPERSEDED\",\n \"version\": \"\",\n \"payload\": {\n \"key_0\": \"string\"\n },\n \"review_task_id\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_by\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2edaba9-4c30-4484-8187-f9e1d4313957", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e154bc4-9de3-462d-85e5-3e0b82a8cc75", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{artifactType}", "description": "", "item": [ { "id": "2c8766fd-1d3a-424b-a212-544df29f994d", "name": "Get one artifact", "request": { "name": "Get one artifact", "description": { "content": "Answers `200` with `\"artifact\": null` when the artifact hasn't been\nauthored yet — an expected state on fresh engagements, not an error.\nA missing engagement still answers 404.\n", "type": "text/plain" }, "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "projectId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "PILOT_CHARTER", "key": "artifactType", "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c5056de9-7f2b-4506-a2e9-8b1f8c25d688", "name": "The artifact, or null when not yet authored", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"artifact\": {\n \"artifact_id\": \"\",\n \"tenant_id\": \"\",\n \"engagement_id\": \"\",\n \"artifact_type\": \"VERIFICATION_PLAN\",\n \"status\": \"IN_REVIEW\",\n \"version\": \"\",\n \"payload\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"review_task_id\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_by\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e7122c-68b5-4aca-a4b2-bbed75e4e96c", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "876ed0ab-3baa-45a5-a2f8-06d2303e852b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0641110e-7073-46ce-a7c0-7356966d8260", "name": "Create or update an artifact (bumps its version)", "request": { "name": "Create or update an artifact (bumps its version)", "description": {}, "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "projectId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "PILOT_CHARTER", "key": "artifactType", "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"key_0\": 2215\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fd188b43-1b6f-4312-aeed-b1370552a5fa", "name": "Artifact updated", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"key_0\": 2215\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"artifact\": {\n \"artifact_id\": \"\",\n \"tenant_id\": \"\",\n \"engagement_id\": \"\",\n \"artifact_type\": \"VERIFICATION_PLAN\",\n \"status\": \"IN_REVIEW\",\n \"version\": \"\",\n \"payload\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"review_task_id\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_by\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1e64382-e231-4b78-bb83-79ace0b41b90", "name": "Artifact created", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"key_0\": 2215\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"artifact\": {\n \"artifact_id\": \"\",\n \"tenant_id\": \"\",\n \"engagement_id\": \"\",\n \"artifact_type\": \"VERIFICATION_PLAN\",\n \"status\": \"IN_REVIEW\",\n \"version\": \"\",\n \"payload\": {\n \"key_0\": false,\n \"key_1\": true\n },\n \"review_task_id\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_by\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b8b2aa9-c1d3-43a7-8232-6d62e1bb9a2c", "name": "Invalid request", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"key_0\": 2215\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d2dd884-3931-4be2-b033-99353bcc4ac3", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"key_0\": 2215\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21772688-c7ce-4b61-bd38-0de328840024", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"key_0\": 2215\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "630a7451-7e37-408a-8084-fb547926f496", "name": "State conflict", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"payload\": {\n \"key_0\": 2215\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "submit", "description": "", "item": [ { "id": "7a21a14f-8037-4225-b220-3b15a2048530", "name": "Submit an artifact for review", "request": { "name": "Submit an artifact for review", "description": {}, "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "projectId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "PILOT_CHARTER", "key": "artifactType", "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reviewer_role\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b16121c8-18da-48d2-8421-de2161ae6335", "name": "Artifact moved to IN_REVIEW with a review task", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reviewer_role\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"artifact\": {\n \"artifact_id\": \"\",\n \"tenant_id\": \"\",\n \"engagement_id\": \"\",\n \"artifact_type\": \"EVIDENCE_PACK\",\n \"status\": \"SUPERSEDED\",\n \"version\": \"\",\n \"payload\": {\n \"key_0\": \"string\",\n \"key_1\": 4365.5804074254265,\n \"key_2\": \"string\"\n },\n \"review_task_id\": \"\",\n \"approved_by\": \"\",\n \"approved_at\": \"\",\n \"created_by\": \"\",\n \"created_at\": \"\",\n \"updated_by\": \"\",\n \"updated_at\": \"\"\n },\n \"review_task\": {\n \"task_id\": \"\",\n \"tenant_id\": \"\",\n \"subject_id\": \"\",\n \"reviewer_role\": \"\",\n \"status\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68f3ed0f-163f-4b7f-9465-86753bf910cd", "name": "Invalid request", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reviewer_role\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80b3f9c2-91b6-4025-9154-46b7efe12299", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reviewer_role\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db66ac14-5b1b-4b5d-9b97-712b05185076", "name": "Resource not found", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reviewer_role\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e8b5b74-e166-4246-8c2d-43a55691b9a8", "name": "State conflict", "originalRequest": { "url": { "path": [ "partner", "projects", ":projectId", "artifacts", ":artifactType", "submit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "projectId" }, { "disabled": false, "description": { "content": "(Required) (This can only be one of PILOT_CHARTER,MANDATE_DESIGN,VERIFICATION_PLAN,EVIDENCE_PACK,PILOT_GATE_DECISION,OPERATIONS_HANDOVER)", "type": "text/plain" }, "type": "any", "value": "PILOT_CHARTER", "key": "artifactType" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reviewer_role\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] } ] }, { "name": "org-units", "description": "", "item": [ { "id": "1d317949-ad65-4e51-8908-4c8439430438", "name": "Create an organisational unit", "request": { "name": "Create an organisational unit", "description": { "content": "Creates an accountability unit inside the tenant. Every unit names an\naccountable owner; the hierarchy is bounded to four levels so aggregated\nreporting stays readable.\n\nThe first unit created may omit `parent_id` and becomes the root. Any\nlater unit must name an existing parent.\n", "type": "text/plain" }, "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"kind\": \"team\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "08f30391-cee4-44b8-9097-bf94629fb774", "name": "Org unit created", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"kind\": \"team\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"division\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ce94032-cab6-4311-b7eb-c1a546d1e6d2", "name": "Invalid request", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"kind\": \"team\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cbb68e2-6667-401c-bae3-8d5fd11d0765", "name": "Authentication required", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"kind\": \"team\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35a4ff2d-320a-4bd6-b228-5ce30d1188ad", "name": "Caller lacks the `tenant:write` permission", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"kind\": \"team\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35ffece4-8f59-4947-942d-c6acfb3769ef", "name": "Named parent unit does not exist", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"kind\": \"team\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"MAX_DEPTH_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e076c1ef-7820-46d1-9cd6-247007ae0cb0", "name": "Placement conflicts with the existing structure — a second root, a\ndepth beyond four levels, a cycle, or a parent/child kind pairing\nthat is not allowed.", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"kind\": \"team\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"MAX_DEPTH_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b172b580-d4e1-46bf-a757-123b44f689fc", "name": "List organisational units", "request": { "name": "List organisational units", "description": { "content": "Returns every unit of the tenant. The result is not paginated: the\nhierarchy is bounded by design and a management view needs the whole\ntree to render it.\n", "type": "text/plain" }, "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Restrict to active or archived units (This can only be one of ACTIVE,ARCHIVED)", "type": "text/plain" }, "key": "status", "value": "ARCHIVED" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6d3c2311-ccb7-4db3-b687-3c24d31c96ce", "name": "Org units of the tenant", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Restrict to active or archived units (This can only be one of ACTIVE,ARCHIVED)", "type": "text/plain" }, "key": "status", "value": "ARCHIVED" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"root\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"division\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ARCHIVED\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\"\n }\n }\n ],\n \"total_count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f963b7d-c32a-46eb-9cf8-e611ecdabefe", "name": "Invalid request", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Restrict to active or archived units (This can only be one of ACTIVE,ARCHIVED)", "type": "text/plain" }, "key": "status", "value": "ARCHIVED" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1525c4c8-2188-4688-a6d8-e30d7e5b2387", "name": "Authentication required", "originalRequest": { "url": { "path": [ "org-units" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Restrict to active or archived units (This can only be one of ACTIVE,ARCHIVED)", "type": "text/plain" }, "key": "status", "value": "ARCHIVED" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "e67efc87-54cd-48b0-8b38-1dfa2a576dbc", "name": "Get an organisational unit", "request": { "name": "Get an organisational unit", "description": {}, "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ee631a30-2694-496f-a169-97869a205961", "name": "Org unit", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"division\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "994db16f-c44e-46f5-9b63-5ececb6d5066", "name": "Authentication required", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c08e54ed-ec4d-4340-862b-508c4509dab0", "name": "Org unit not found", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70d1fce4-b785-4087-9c7f-d001fd26198a", "name": "Update an organisational unit", "request": { "name": "Update an organisational unit", "description": { "content": "Updates descriptive fields and accountable ownership. `kind`,\n`parent_id`, `path` and `depth` are immutable: moving a unit changes the\nmeaning of every historical aggregation that referenced it, so a move is\nmodelled as archive plus create rather than an in-place edit.\n", "type": "text/plain" }, "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "37008af4-a59e-4979-b7a6-3b3cb143cdf7", "name": "Updated org unit", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"division\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2bb24a3-ec98-469a-a60b-c20ccdae281e", "name": "Invalid request", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b613095e-b0c4-4211-9702-76bf7cd40c60", "name": "Authentication required", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f816509-8475-440a-b96d-9c8eaa42cf81", "name": "Caller lacks the `tenant:write` permission", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ef440af-cf5c-4044-919c-f5fa33951bee", "name": "Org unit not found", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03296fa7-bdd7-4f31-ae33-afa9df456705", "name": "Archive an organisational unit", "request": { "name": "Archive an organisational unit", "description": { "content": "Archives the unit. This is a soft delete: mandates and audit events keep\nreferencing it, so hard deletion would break the evidence trail the\nplatform exists to preserve.\n\nA unit with active children cannot be archived — archiving a parent\nwould leave its children unreachable in the tree while still active.\n", "type": "text/plain" }, "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "11d801bd-412f-4796-919f-5d1e32a14de4", "name": "Archived org unit", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"division\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb5e42a8-d2e9-4682-8736-81848738dbaa", "name": "Authentication required", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f591bca8-0b89-4924-be50-8029ce80f84d", "name": "Caller lacks the `tenant:write` permission", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e132bcaf-eae9-499f-b61e-50cd0a9780e8", "name": "Org unit not found", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e5f0aef-8616-4613-bed2-1629a21f20c0", "name": "Unit still has active children", "originalRequest": { "url": { "path": [ "org-units", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"MAX_DEPTH_EXCEEDED\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "subtree", "description": "", "item": [ { "id": "330f99d1-7984-43f8-be7b-ad6d4d702afb", "name": "Resolve a unit and everything below it", "request": { "name": "Resolve a unit and everything below it", "description": { "content": "Returns the unit together with all descendants, resolved from the\nmaterialised ancestor path in a single read. This is the aggregation\nboundary for management reporting: \"everything below this division\".\n", "type": "text/plain" }, "url": { "path": [ "org-units", ":id", "subtree" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "700b8212-2097-4672-a55b-b9aaa95279b2", "name": "Unit and its descendants", "originalRequest": { "url": { "path": [ "org-units", ":id", "subtree" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"root\": {\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"team\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ACTIVE\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\"\n }\n },\n \"items\": [\n {\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"root\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ARCHIVED\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"org_unit_id\": \"\",\n \"tenant_id\": \"\",\n \"kind\": \"root\",\n \"name\": \"\",\n \"owner\": {\n \"subject_id\": \"\",\n \"display_name\": \"\",\n \"email\": \"\",\n \"role_title\": \"\"\n },\n \"status\": \"ARCHIVED\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"depth\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"parent_id\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"key_0\": \"\"\n }\n }\n ],\n \"total_count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06aa9fd9-d5a2-489f-9730-fb31511ba0e2", "name": "Authentication required", "originalRequest": { "url": { "path": [ "org-units", ":id", "subtree" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d14b07a-f7ed-4eca-bdf2-9a37c628d500", "name": "Org unit not found", "originalRequest": { "url": { "path": [ "org-units", ":id", "subtree" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "governance", "description": "", "item": [ { "name": "posture", "description": "", "item": [ { "id": "ae88c993-c998-49f7-af05-04e0c7f76630", "name": "Aggregated governance posture for the tenant", "request": { "name": "Aggregated governance posture for the tenant", "description": { "content": "Aggregated governance indicators over a bounded window, for oversight\nroles rather than operators. Answers \"is the delegation posture\nacceptable, and where is it worst\" — a question the per-mandate surfaces\ncannot.\n\n**Rates carry their denominators.** Every rate reports `numerator` and\n`denominator`, and `value` is `null` when the denominator is zero. A\ndenial rate of zero from four checks and one from no checks are different\nstatements; a bare `0` would conflate them.\n\n**Coverage is explicit.** The read is bounded in both window length and\nindex pages. When either bound truncates the read, `coverage.truncated`\nis `true` and a `WINDOW_TRUNCATED` caveat is present. Callers must not\npresent figures as complete without checking it.\n\n**Caveats are part of the answer.** They flag conditions that make an\nindicator misleading — no verifications in the window, a small latency\nsample, unassigned mandates, unscoreable risk profiles. A dashboard that\nrenders the numbers and drops the caveats will mislead its reader.\n", "type": "text/plain" }, "url": { "path": [ "governance", "posture" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Length of the reporting window in days. Rejected rather than clamped\nwhen out of range, so the response always answers the question that\nwas asked.\n", "type": "text/plain" }, "key": "window_days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "453f69a7-0253-40a5-b88b-2f05b4bbf772", "name": "Aggregated posture.", "originalRequest": { "url": { "path": [ "governance", "posture" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Length of the reporting window in days. Rejected rather than clamped\nwhen out of range, so the response always answers the question that\nwas asked.\n", "type": "text/plain" }, "key": "window_days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tenant_id\": \"\",\n \"generated_at\": \"\",\n \"coverage\": {\n \"window_start\": \"\",\n \"window_end\": \"\",\n \"events_scanned\": \"\",\n \"pages_scanned\": \"\",\n \"truncated\": \"\",\n \"earliest_event\": \"\",\n \"latest_event\": \"\"\n },\n \"boundary_adherence\": {\n \"verification_allowed\": \"\",\n \"verification_denied\": \"\",\n \"verification_total\": \"\",\n \"denial_rate\": {\n \"value\": \"\",\n \"numerator\": \"\",\n \"denominator\": \"\"\n },\n \"mandates_with_denials\": \"\"\n },\n \"human_oversight\": {\n \"consent_requested\": \"\",\n \"consent_approved\": \"\",\n \"consent_rejected\": \"\",\n \"consent_auto_approved\": \"\",\n \"consent_expired\": \"\",\n \"escalations_triggered\": \"\",\n \"human_review_rate\": {\n \"value\": \"\",\n \"numerator\": \"\",\n \"denominator\": \"\"\n },\n \"rejection_rate\": {\n \"value\": \"\",\n \"numerator\": \"\",\n \"denominator\": \"\"\n }\n },\n \"response_latency\": {\n \"sample_size\": \"\",\n \"denials_without_containment\": \"\",\n \"median_seconds\": \"\",\n \"p90_seconds\": \"\"\n },\n \"risk_distribution\": {\n \"low\": \"\",\n \"moderate\": \"\",\n \"high\": \"\",\n \"critical\": \"\",\n \"unclassified\": \"\",\n \"invalid\": \"\",\n \"classification_coverage\": {\n \"value\": \"\",\n \"numerator\": \"\",\n \"denominator\": \"\"\n },\n \"eu_ai_act_high_risk_declared\": \"\"\n },\n \"org_breakdown\": [\n {\n \"unit_id\": \"\",\n \"unit_name\": \"\",\n \"mandate_count\": \"\",\n \"active_mandate_count\": \"\",\n \"classified_mandate_count\": \"\",\n \"verification_denied\": \"\",\n \"escalations_triggered\": \"\",\n \"owner_subject_id\": \"\",\n \"peak_risk_band\": \"low\"\n },\n {\n \"unit_id\": \"\",\n \"unit_name\": \"\",\n \"mandate_count\": \"\",\n \"active_mandate_count\": \"\",\n \"classified_mandate_count\": \"\",\n \"verification_denied\": \"\",\n \"escalations_triggered\": \"\",\n \"owner_subject_id\": \"\",\n \"peak_risk_band\": \"low\"\n }\n ],\n \"caveats\": [\n {\n \"code\": \"MANDATE_SCAN_TRUNCATED\",\n \"message\": \"\"\n },\n {\n \"code\": \"WINDOW_TRUNCATED\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12870de1-3325-469e-9c5a-f7ed8cf03a70", "name": "Missing tenant context or window outside the permitted range.", "originalRequest": { "url": { "path": [ "governance", "posture" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Length of the reporting window in days. Rejected rather than clamped\nwhen out of range, so the response always answers the question that\nwas asked.\n", "type": "text/plain" }, "key": "window_days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b979c04-4c6b-45a1-a224-113da7ffcc10", "name": "Missing `mandates:read` scope.", "originalRequest": { "url": { "path": [ "governance", "posture" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Length of the reporting window in days. Rejected rather than clamped\nwhen out of range, so the response always answers the question that\nwas asked.\n", "type": "text/plain" }, "key": "window_days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb3f554b-32c2-46cc-a895-22d5d9f4f175", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "governance", "posture" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Length of the reporting window in days. Rejected rather than clamped\nwhen out of range, so the response always answers the question that\nwas asked.\n", "type": "text/plain" }, "key": "window_days", "value": "30" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "X-Api-Key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "X-Api-Key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.mandaitor.io/v1" } ], "info": { "_postman_id": "9454afb1-7f1e-46f0-b1b9-9de03c508283", "name": "Mandaitor Delegation Mandate Registry API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Neutral, trustworthy infrastructure for verifiable delegated authority\nbetween humans and AI agents.\n\n\nContact Support:\n Name: Mandaitor API Support\n Email: api@mandaitor.io", "type": "text/plain" } } }