{ "info": { "_postman_id": "e8d32b89-98ab-40a0-8541-950be5556d7f", "name": "Mimecast API 2.0 - 2024-11-06", "description": "Interact with Mimecast via the API 2.0 gateway.\n\nContact Support:\n Name: Mimecast Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "1421581" }, "item": [ { "name": "api", "item": [ { "name": "account", "item": [ { "name": "get-account", "item": [ { "name": "Account Get Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] }, "description": " This endpoint returns the summary details for an account in Mimecast. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"accountCode\": \"\",\n \"accountName\": \"\",\n \"adminEmail\": \"\",\n \"archive\": \"\",\n \"automatedSegmentPurge\": \"\",\n \"databaseCode\": \"\",\n \"domain\": \"\",\n \"gateway\": \"\",\n \"mailPlatform\": \"\",\n \"maxRetention\": \"\",\n \"maxRetentionConfirmed\": \"\",\n \"mimecastId\": \"\",\n \"packages\": [\n \"\",\n \"\"\n ],\n \"passphrase\": \"\",\n \"policyInheritance\": \"\",\n \"region\": \"\",\n \"type\": \"\",\n \"userCount\": \"\"\n },\n {\n \"accountCode\": \"\",\n \"accountName\": \"\",\n \"adminEmail\": \"\",\n \"archive\": \"\",\n \"automatedSegmentPurge\": \"\",\n \"databaseCode\": \"\",\n \"domain\": \"\",\n \"gateway\": \"\",\n \"mailPlatform\": \"\",\n \"maxRetention\": \"\",\n \"maxRetentionConfirmed\": \"\",\n \"mimecastId\": \"\",\n \"packages\": [\n \"\",\n \"\"\n ],\n \"passphrase\": \"\",\n \"policyInheritance\": \"\",\n \"region\": \"\",\n \"type\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-account", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-account" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] }, { "name": "get-dashboard-notifications", "item": [ { "name": "Account Get Dashboard Notifications", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] }, "description": " This feed can be used to return dashboard notifications from the Administration Console Dashboard. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"notifications\": [\n {\n \"clusterCode\": \"\",\n \"customerCode\": \"\",\n \"displayMessage\": \"\",\n \"enabled\": \"\",\n \"id\": \"\",\n \"noticeType\": \"\",\n \"title\": \"\",\n \"visibleFrom\": \"\",\n \"warningLevel\": \"\"\n },\n {\n \"clusterCode\": \"\",\n \"customerCode\": \"\",\n \"displayMessage\": \"\",\n \"enabled\": \"\",\n \"id\": \"\",\n \"noticeType\": \"\",\n \"title\": \"\",\n \"visibleFrom\": \"\",\n \"warningLevel\": \"\"\n }\n ]\n },\n {\n \"notifications\": [\n {\n \"clusterCode\": \"\",\n \"customerCode\": \"\",\n \"displayMessage\": \"\",\n \"enabled\": \"\",\n \"id\": \"\",\n \"noticeType\": \"\",\n \"title\": \"\",\n \"visibleFrom\": \"\",\n \"warningLevel\": \"\"\n },\n {\n \"clusterCode\": \"\",\n \"customerCode\": \"\",\n \"displayMessage\": \"\",\n \"enabled\": \"\",\n \"id\": \"\",\n \"noticeType\": \"\",\n \"title\": \"\",\n \"visibleFrom\": \"\",\n \"warningLevel\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"accountCode\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/account/get-dashboard-notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-dashboard-notifications" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-support-info", "item": [ { "name": "Account Get Support Info", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] }, "description": " This endpoint returns support information that is associated with a Mimecast tenant. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"customerAdvocate\": \"\",\n \"customerDevelopmentManager\": \"\",\n \"hostingJurisdiction\": \"\",\n \"mailtoLink\": \"\",\n \"mainProduct\": \"\",\n \"officePhone\": \"\",\n \"partnerName\": \"\",\n \"renewalDate\": \"\",\n \"supportJurisdiction\": \"\",\n \"supportPackage\": \"\"\n },\n {\n \"customerAdvocate\": \"\",\n \"customerDevelopmentManager\": \"\",\n \"hostingJurisdiction\": \"\",\n \"mailtoLink\": \"\",\n \"mainProduct\": \"\",\n \"officePhone\": \"\",\n \"partnerName\": \"\",\n \"renewalDate\": \"\",\n \"supportJurisdiction\": \"\",\n \"supportPackage\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/account/get-support-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "account", "get-support-info" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] } ] }, { "name": "provisioning", "item": [ { "name": "get-packages", "item": [ { "name": "Provisioning Get Packages", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] }, "description": " This endpoint returns products that are available to be provisioned by a partner. Pre-requisites To use this endpoint the requesting user must be a member of the Partner Provisioning Role. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"products\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"products\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/provisioning/get-packages", "host": [ "{{baseUrl}}" ], "path": [ "api", "provisioning", "get-packages" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] } ] }, { "name": "archive", "item": [ { "name": "get-message-detail", "item": [ { "name": "Archive Get Message Detail", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] }, "description": " Retrieves archived message details. Pre-requisites In order to successfully use this endpoint to load any archived message for any user, the role assigned to the app must have at least the following level of application permissions granted Archive | Search Content View . To use this endpoint to load messages sent or received by the logged in user or an address that the logged in user has delegate permission to, no administrator permissions are required. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"attachments\": [\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n },\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n }\n ],\n \"cc\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ],\n \"envelopeFrom\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"hasHtmlBody\": \"\",\n \"hasTextBody\": \"\",\n \"headerDate\": \"\",\n \"headers\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ],\n \"id\": {},\n \"messageBodyPreview\": \"\",\n \"mimeMessageId\": \"\",\n \"processed\": \"\",\n \"received\": \"\",\n \"replyTo\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"size\": \"\",\n \"smash\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n },\n {\n \"attachments\": [\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n },\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n }\n ],\n \"cc\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ],\n \"envelopeFrom\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"hasHtmlBody\": \"\",\n \"hasTextBody\": \"\",\n \"headerDate\": \"\",\n \"headers\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ],\n \"id\": {},\n \"messageBodyPreview\": \"\",\n \"mimeMessageId\": \"\",\n \"processed\": \"\",\n \"received\": \"\",\n \"replyTo\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"size\": \"\",\n \"smash\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Binding Expired\tThe TTL of the access key and secret key issued on successful login has lapsed and the binding should be refreshed as described in the Understanding API Authentication guide.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "I'm a teapot (RFC 2324)", "code": 418, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-detail" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-message-list", "item": [ { "name": "Archive Get Message List", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] }, "description": " Retrieves archive message list. Pre-requisites In order to successfully use this endpoint to request message lists for any user,the role assigned to the app must have at least the following level of application permissions granted Archive| Search | Read . To use this endpoint to request message lists for the logged in user or an address that the logged in user has delegate permission to, no administrator permissions are required. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"attachmentCount\": \"\",\n \"ccm\": \"\",\n \"expired\": \"\",\n \"from\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": {},\n \"read\": \"\",\n \"recalled\": \"\",\n \"received\": \"\",\n \"size\": \"\",\n \"smash\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n },\n {\n \"attachmentCount\": \"\",\n \"ccm\": \"\",\n \"expired\": \"\",\n \"from\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": {},\n \"read\": \"\",\n \"recalled\": \"\",\n \"received\": \"\",\n \"size\": \"\",\n \"smash\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n }\n ]\n}" }, { "name": "Binding Expired\tThe TTL of the access key and secret key issued on successful login has lapsed and the binding should be refreshed as described in the Understanding API Authentication guide.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "I'm a teapot (RFC 2324)", "code": 418, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-list" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"INBOX\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"includeAliases\": \"\",\n \"includeDelegates\": \"\",\n \"mailbox\": \"\",\n \"start\": \"\",\n \"view\": \"SENT\"\n }\n }\n ]\n}" } ] } ] }, { "name": "search", "item": [ { "name": "Archive Search", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Modify the fields here to build a basic Muse query", "// To build more complex queries, read here: https://developer.services.mimecast.com/building-search-queries", "", "var searchTerm = \"Test\" // Basic words, phrases, optionally in specific parts of a message.", "var mailboxes = [] // List of mailbox email addresses to search. Optional.", "var fields = [ // Fields to be returned in the response.", " \"attachmentcount\",", " \"status\",", " \"subject\",", " \"size\",", " \"receiveddate\",", " \"displayfrom\",", " \"displayfromaddress\",", " \"id\",", " \"displayto\",", " \"displaytoaddresslist\",", " \"smash\"", "]", "var results = 25 // Number of results to return. Max 500.", "", "", "", "", "// --- The code below builds the Muse query based on the above fields ---", "", "var output = ``", "", "// Add Mailboxes", "if (mailboxes !== undefined && mailboxes.length > 0) {", " output += \"\"", " mailboxes.forEach(mailbox => {", " output += `${mailbox}`", " })", " output += \"\"", "}", "", "// Add Fields", "if (fields !== undefined && fields.length > 0) {", " output += \"\"", " fields.forEach(field => {", " output += `${field}`", " })", " output += \"\"", "}", "", "output += \"\"", "", "// Add Mailboxes", "if (![undefined, null,\"\"].includes(searchTerm)) {", " output += `${searchTerm}`", "}", "", "output += \"\"", "output = output.replace(/\"/gm, '\\\\\"')", "pm.variables.set(\"searchQuery\", output)" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"meta\": {},\n \"data\": [\n {\n \"admin\": true,\n \"query\": \"{{searchQuery}}\" // You can set properties under this API call's Scripts / Pre-request\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] }, "description": " Retrieves archive search items. Pre-requisites In order to successfully use this endpoint to search across a customers entire archive, the role assigned to the app must have at least the following level of application permissions granted Archive | Search | Read . To use this endpoint to search for messages for the logged in user or an address that the logged in user has delegate permission to, no administrator permissions are required. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"queryDuration\": \"\"\n },\n {\n \"queryDuration\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Binding Expired\tThe TTL of the access key and secret key issued on successful login has lapsed and the binding should be refreshed as described in the Understanding API Authentication guide.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "I'm a teapot (RFC 2324)", "code": 418, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"admin\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "search" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-message-part", "item": [ { "name": "Archive Get Message Part", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] }, "description": " Retrieves the message part - HTML, plain or RFC822. Pre-requisites In order to successfully use this endpoint to retrieve the message part - HTML, plain or RFC822, the role assigned to the app must have at least the following level of application permissions granted Archive | Read . To use this endpoint to retrieve the message part - HTML, plain or RFC822 for the logged in user or an address that the logged in user has delegate permission to, no administrator permissions are required. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"meta\": {\n \"status\": \"\"\n },\n \"data\": [\n {\n \"urls\": [\n \"\"\n ]\n },\n {\n \"urls\": [\n \"\"\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Binding Expired\tThe TTL of the access key and secret key issued on successful login has lapsed and the binding should be refreshed as described in the Understanding API Authentication guide.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "I'm a teapot (RFC 2324)", "code": 418, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"context\": \"DELIVERED\",\n \"id\": \"\",\n \"type\": \"RFC822\",\n \"extractFromHtml\": \"\",\n \"mailbox\": \"\",\n \"stripDangerous\": \"\",\n \"stripImg\": \"\",\n \"stripStyles\": \"\",\n \"transposeInlineCID\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-message-part", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-message-part" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" } ] } ] }, { "name": "get-file", "item": [ { "name": "Archive Get File", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] }, "description": " Retrieves the file or attachment for given id. Pre-requisites In order to successfully use this endpoint to retrieve the file or attachment for given id, the role assigned to the app must have at least the following level of application permissions granted Archive | Read . To use this endpoint to retrieve the file or attachment for given id for the logged in user or an address that the logged in user has delegate permission to, no administrator permissions are required. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"meta\": {\n \"status\": \"\"\n },\n \"data\": [\n {\n \"urls\": [\n \"\"\n ]\n },\n {\n \"urls\": [\n \"\"\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Binding Expired\tThe TTL of the access key and secret key issued on successful login has lapsed and the binding should be refreshed as described in the Understanding API Authentication guide.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "I'm a teapot (RFC 2324)", "code": 418, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-file" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" } ] } ] }, { "name": "get-archive-search-logs", "item": [ { "name": "Archive Get Archive Search Logs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] }, "description": " Retrieves archive search logs. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Archive | Search Logs | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"logs\": [\n {\n \"createTime\": \"\",\n \"description\": \"\",\n \"emailAddr\": \"\",\n \"isAdmin\": \"\",\n \"museQuery\": \"\",\n \"searchPath\": \"\",\n \"searchReason\": \"\",\n \"searchText\": \"\",\n \"source\": \"\"\n },\n {\n \"createTime\": \"\",\n \"description\": \"\",\n \"emailAddr\": \"\",\n \"isAdmin\": \"\",\n \"museQuery\": \"\",\n \"searchPath\": \"\",\n \"searchReason\": \"\",\n \"searchText\": \"\",\n \"source\": \"\"\n }\n ]\n },\n {\n \"logs\": [\n {\n \"createTime\": \"\",\n \"description\": \"\",\n \"emailAddr\": \"\",\n \"isAdmin\": \"\",\n \"museQuery\": \"\",\n \"searchPath\": \"\",\n \"searchReason\": \"\",\n \"searchText\": \"\",\n \"source\": \"\"\n },\n {\n \"createTime\": \"\",\n \"description\": \"\",\n \"emailAddr\": \"\",\n \"isAdmin\": \"\",\n \"museQuery\": \"\",\n \"searchPath\": \"\",\n \"searchReason\": \"\",\n \"searchText\": \"\",\n \"source\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-archive-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-archive-search-logs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-search-logs", "item": [ { "name": "Archive Get Search Logs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] }, "description": " Retrieves the search logs. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Archive | Search Logs | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"logs\": [\n {\n \"createTime\": \"\",\n \"description\": \"\",\n \"emailAddr\": \"\",\n \"isAdmin\": \"\",\n \"museQuery\": \"\",\n \"searchPath\": \"\",\n \"searchReason\": \"\",\n \"searchText\": \"\",\n \"source\": \"\"\n },\n {\n \"createTime\": \"\",\n \"description\": \"\",\n \"emailAddr\": \"\",\n \"isAdmin\": \"\",\n \"museQuery\": \"\",\n \"searchPath\": \"\",\n \"searchReason\": \"\",\n \"searchText\": \"\",\n \"source\": \"\"\n }\n ]\n },\n {\n \"logs\": [\n {\n \"createTime\": \"\",\n \"description\": \"\",\n \"emailAddr\": \"\",\n \"isAdmin\": \"\",\n \"museQuery\": \"\",\n \"searchPath\": \"\",\n \"searchReason\": \"\",\n \"searchText\": \"\",\n \"source\": \"\"\n },\n {\n \"createTime\": \"\",\n \"description\": \"\",\n \"emailAddr\": \"\",\n \"isAdmin\": \"\",\n \"museQuery\": \"\",\n \"searchPath\": \"\",\n \"searchReason\": \"\",\n \"searchText\": \"\",\n \"source\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-search-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-search-logs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-view-logs", "item": [ { "name": "Archive Get View Logs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] }, "description": " Retrieves the email view logs. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Archive | View Logs | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"contentViewed\": \"\",\n \"discoveryCase\": \"\",\n \"from\": \"\",\n \"messageDate\": \"\",\n \"source\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"viewed\": \"\",\n \"viewer\": \"\"\n },\n {\n \"contentViewed\": \"\",\n \"discoveryCase\": \"\",\n \"from\": \"\",\n \"messageDate\": \"\",\n \"source\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"viewed\": \"\",\n \"viewer\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/archive/get-view-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "archive", "get-view-logs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"query\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "audit", "item": [ { "name": "get-audit-events", "item": [ { "name": "Audit Get Audit Events", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] }, "description": " Returns the audit events matching the request. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Logs | Read . Notes The page size should be provided in the meta pagination else would default to the default of 10. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"auditType\": \"\",\n \"category\": \"\",\n \"eventInfo\": \"\",\n \"eventTime\": \"\",\n \"id\": \"\"\n },\n {\n \"auditType\": \"\",\n \"category\": \"\",\n \"eventInfo\": \"\",\n \"eventTime\": \"\",\n \"id\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/audit/get-audit-events", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-audit-events" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"query\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-categories", "item": [ { "name": "Audit Get Categories", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] }, "description": " Returns the list of audit categories available. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"categories\": [\n {\n \"code\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"code\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"categories\": [\n {\n \"code\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"code\": \"\",\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/audit/get-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "audit", "get-categories" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] } ] }, { "name": "gateway", "item": [ { "name": "get-held-release-logs", "item": [ { "name": "Gateway Get Held Release Logs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] }, "description": " This endpoint can be used to find messages that were either released to the recipient, with details about the user that processed the release. These logs also include messages that expired in the held queue, and were dropped by Mimecast housekeeping services. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Monitoring | Held | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"heldReleaseLogs\": [\n {\n \"attachments\": \"\",\n \"detectionLevel\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHdr\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"heldGroup\": \"\",\n \"heldReason\": \"\",\n \"id\": \"\",\n \"messageInfo\": \"\",\n \"operator\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"policy\": \"\",\n \"rejectReason\": \"\",\n \"released\": \"\",\n \"route\": \"\",\n \"size\": \"\",\n \"spamProcessingDetail\": {\n \"dkim\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"dmarc\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"greyEmail\": \"\",\n \"managedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"permittedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"rbl\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"spf\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"verdict\": {\n \"categories\": [\n {\n \"name\": \"\",\n \"risk\": \"\",\n \"subcategories\": [\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"risk\": \"\",\n \"subcategories\": [\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n }\n ]\n }\n ],\n \"decision\": \"\",\n \"description\": \"\",\n \"risk\": \"\"\n }\n },\n \"spamScore\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n },\n {\n \"attachments\": \"\",\n \"detectionLevel\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHdr\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"heldGroup\": \"\",\n \"heldReason\": \"\",\n \"id\": \"\",\n \"messageInfo\": \"\",\n \"operator\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"policy\": \"\",\n \"rejectReason\": \"\",\n \"released\": \"\",\n \"route\": \"\",\n \"size\": \"\",\n \"spamProcessingDetail\": {\n \"dkim\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"dmarc\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"greyEmail\": \"\",\n \"managedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"permittedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"rbl\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"spf\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"verdict\": {\n \"categories\": [\n {\n \"name\": \"\",\n \"risk\": \"\",\n \"subcategories\": [\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"risk\": \"\",\n \"subcategories\": [\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n }\n ]\n }\n ],\n \"decision\": \"\",\n \"description\": \"\",\n \"risk\": \"\"\n }\n },\n \"spamScore\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"heldReleaseLogs\": [\n {\n \"attachments\": \"\",\n \"detectionLevel\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHdr\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"heldGroup\": \"\",\n \"heldReason\": \"\",\n \"id\": \"\",\n \"messageInfo\": \"\",\n \"operator\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"policy\": \"\",\n \"rejectReason\": \"\",\n \"released\": \"\",\n \"route\": \"\",\n \"size\": \"\",\n \"spamProcessingDetail\": {\n \"dkim\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"dmarc\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"greyEmail\": \"\",\n \"managedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"permittedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"rbl\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"spf\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"verdict\": {\n \"categories\": [\n {\n \"name\": \"\",\n \"risk\": \"\",\n \"subcategories\": [\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"risk\": \"\",\n \"subcategories\": [\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n }\n ]\n }\n ],\n \"decision\": \"\",\n \"description\": \"\",\n \"risk\": \"\"\n }\n },\n \"spamScore\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n },\n {\n \"attachments\": \"\",\n \"detectionLevel\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHdr\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"heldGroup\": \"\",\n \"heldReason\": \"\",\n \"id\": \"\",\n \"messageInfo\": \"\",\n \"operator\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"policy\": \"\",\n \"rejectReason\": \"\",\n \"released\": \"\",\n \"route\": \"\",\n \"size\": \"\",\n \"spamProcessingDetail\": {\n \"dkim\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"dmarc\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"greyEmail\": \"\",\n \"managedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"permittedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"rbl\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"spf\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"verdict\": {\n \"categories\": [\n {\n \"name\": \"\",\n \"risk\": \"\",\n \"subcategories\": [\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"risk\": \"\",\n \"subcategories\": [\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"augmentations\": [\n {\n \"name\": \"\",\n \"risk\": \"\"\n },\n {\n \"name\": \"\",\n \"risk\": \"\"\n }\n ],\n \"name\": \"\",\n \"risk\": \"\"\n }\n ]\n }\n ],\n \"decision\": \"\",\n \"description\": \"\",\n \"risk\": \"\"\n }\n },\n \"spamScore\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-held-release-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-held-release-logs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-rejections", "item": [ { "name": "Gateway Get Rejections", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] }, "description": " This endpoint can be used to find rejected messages and the reasons for their rejection. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Monitoring | Rejections | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"rejections\": [\n {\n \"created\": \"\",\n \"description\": \"\",\n \"detectionLevel\": \"\",\n \"fromAddress\": \"\",\n \"id\": \"\",\n \"info\": \"\",\n \"ipAddress\": \"\",\n \"manageRecipient\": \"\",\n \"remoteEhlo\": \"\",\n \"remoteName\": \"\",\n \"spamScore\": \"\",\n \"toAddress\": \"\",\n \"toAddressPostCheck\": \"\",\n \"toAddressPreCheck\": \"\",\n \"type\": \"\"\n },\n {\n \"created\": \"\",\n \"description\": \"\",\n \"detectionLevel\": \"\",\n \"fromAddress\": \"\",\n \"id\": \"\",\n \"info\": \"\",\n \"ipAddress\": \"\",\n \"manageRecipient\": \"\",\n \"remoteEhlo\": \"\",\n \"remoteName\": \"\",\n \"spamScore\": \"\",\n \"toAddress\": \"\",\n \"toAddressPostCheck\": \"\",\n \"toAddressPreCheck\": \"\",\n \"type\": \"\"\n }\n ]\n },\n {\n \"rejections\": [\n {\n \"created\": \"\",\n \"description\": \"\",\n \"detectionLevel\": \"\",\n \"fromAddress\": \"\",\n \"id\": \"\",\n \"info\": \"\",\n \"ipAddress\": \"\",\n \"manageRecipient\": \"\",\n \"remoteEhlo\": \"\",\n \"remoteName\": \"\",\n \"spamScore\": \"\",\n \"toAddress\": \"\",\n \"toAddressPostCheck\": \"\",\n \"toAddressPreCheck\": \"\",\n \"type\": \"\"\n },\n {\n \"created\": \"\",\n \"description\": \"\",\n \"detectionLevel\": \"\",\n \"fromAddress\": \"\",\n \"id\": \"\",\n \"info\": \"\",\n \"ipAddress\": \"\",\n \"manageRecipient\": \"\",\n \"remoteEhlo\": \"\",\n \"remoteName\": \"\",\n \"spamScore\": \"\",\n \"toAddress\": \"\",\n \"toAddressPostCheck\": \"\",\n \"toAddressPreCheck\": \"\",\n \"type\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-rejections", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-rejections" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"mailbox\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "find-processing-messages", "item": [ { "name": "Gateway Find Processing Messages", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] }, "description": " This API endpoint will return messages currently being processed by Mimecast. Given the speed at which messages are processed, it is not uncommon for this endpoint to return no results, as the platform may not be processing a message at the moment or request. More information on the Processing Queue can be found in Mimecaster Central . All request fields are optional, however at least one option must be presented in the request body. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Monitoring | Processing | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"messages\": [\n {\n \"attachment\": \"\",\n \"attempts\": \"\",\n \"created\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHeader\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"info\": \"\",\n \"lockedUntil\": \"\",\n \"nextAttempt\": \"\",\n \"priority\": \"\",\n \"remoteIp\": \"\",\n \"routing\": \"\",\n \"size\": \"\",\n \"subject\": \"\",\n \"to\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n },\n {\n \"attachment\": \"\",\n \"attempts\": \"\",\n \"created\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHeader\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"info\": \"\",\n \"lockedUntil\": \"\",\n \"nextAttempt\": \"\",\n \"priority\": \"\",\n \"remoteIp\": \"\",\n \"routing\": \"\",\n \"size\": \"\",\n \"subject\": \"\",\n \"to\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n }\n ]\n },\n {\n \"messages\": [\n {\n \"attachment\": \"\",\n \"attempts\": \"\",\n \"created\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHeader\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"info\": \"\",\n \"lockedUntil\": \"\",\n \"nextAttempt\": \"\",\n \"priority\": \"\",\n \"remoteIp\": \"\",\n \"routing\": \"\",\n \"size\": \"\",\n \"subject\": \"\",\n \"to\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n },\n {\n \"attachment\": \"\",\n \"attempts\": \"\",\n \"created\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHeader\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"info\": \"\",\n \"lockedUntil\": \"\",\n \"nextAttempt\": \"\",\n \"priority\": \"\",\n \"remoteIp\": \"\",\n \"routing\": \"\",\n \"size\": \"\",\n \"subject\": \"\",\n \"to\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"asc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"asc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/find-processing-messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "find-processing-messages" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"asc\",\n \"start\": \"\",\n \"type\": \"bulk_processing\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"sortBy\": \"createTime\",\n \"sortOrder\": \"desc\",\n \"start\": \"\",\n \"type\": \"processing\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-hold-message-list", "item": [ { "name": "Gateway Get Hold Message List", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] }, "description": " This API endpoint can be used to get information about held messages, including the reason, hold level, sender and recipients. The ID can be used to act on a message using the Release Message or Reject Message API endpoints. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"dateReceived\": \"\",\n \"from\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHeader\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"hasAttachments\": \"\",\n \"id\": \"\",\n \"policyInfo\": \"\",\n \"reason\": \"\",\n \"reasonCode\": \"\",\n \"route\": \"\",\n \"size\": \"\",\n \"subject\": \"\",\n \"to\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n },\n {\n \"dateReceived\": \"\",\n \"from\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHeader\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"hasAttachments\": \"\",\n \"id\": \"\",\n \"policyInfo\": \"\",\n \"reason\": \"\",\n \"reasonCode\": \"\",\n \"route\": \"\",\n \"size\": \"\",\n \"subject\": \"\",\n \"to\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-message-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-message-list" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"admin\": \"\",\n \"end\": \"\",\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-hold-summary-list", "item": [ { "name": "Gateway Get Hold Summary List", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] }, "description": " This API endpoint can be used to get counts of currently held messages for each hold reason. Hold reasons can reference policy actions or definition names. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Monitoring | Held Summary | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"numberOfItems\": \"\",\n \"policyInfo\": \"\"\n },\n {\n \"numberOfItems\": \"\",\n \"policyInfo\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/gateway/get-hold-summary-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "get-hold-summary-list" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] }, { "name": "hold-reject", "item": [ { "name": "Gateway Hold Reject", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] }, "description": " This API endpoint can be used to reject a currently held message based on the Find Held Messages API endpoint Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Monitoring | Held | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"reject\": \"\"\n },\n {\n \"id\": \"\",\n \"reject\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE GOES AGAINST EMAIL POLICIES\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE CONTAINS UNDESIRABLE CONTENT\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"INAPPROPRIATE COMMUNICATION\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE GOES AGAINST EMAIL POLICIES\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"INAPPROPRIATE COMMUNICATION\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE GOES AGAINST EMAIL POLICIES\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"INAPPROPRIATE COMMUNICATION\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE GOES AGAINST EMAIL POLICIES\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"INAPPROPRIATE COMMUNICATION\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE GOES AGAINST EMAIL POLICIES\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"INAPPROPRIATE COMMUNICATION\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE GOES AGAINST EMAIL POLICIES\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"INAPPROPRIATE COMMUNICATION\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE GOES AGAINST EMAIL POLICIES\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"REVIEWER DISAPPROVES OF CONTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-reject" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"INAPPROPRIATE COMMUNICATION\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"ids\": [\n \"\",\n \"\"\n ],\n \"message\": \"\",\n \"notify\": \"\",\n \"reasonType\": \"MESSAGE GOES AGAINST EMAIL POLICIES\"\n }\n }\n ]\n}" } ] } ] }, { "name": "hold-release", "item": [ { "name": "Gateway Hold Release", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] }, "description": " This API endpoint can be used to release a currently held message based on the Find Held Messages API endpoint Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Monitoring | Held | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"release\": \"\"\n },\n {\n \"id\": \"\",\n \"release\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/hold-release", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "hold-release" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "message", "item": [ { "name": "get-file", "item": [ { "name": "Message Get File", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] }, "description": " This API endpoint can be used to retrieve the file or attachment for given id. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"meta\": {\n \"status\": \"\"\n },\n \"data\": [\n {\n \"urls\": [\n \"\"\n ]\n },\n {\n \"urls\": [\n \"\"\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Binding Expired\tThe TTL of the access key and secret key issued on successful login has lapsed and the binding should be refreshed as described in the Understanding API Authentication guide.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "I'm a teapot (RFC 2324)", "code": 418, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/gateway/message/get-file", "host": [ "{{baseUrl}}" ], "path": [ "api", "gateway", "message", "get-file" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "awareness-training", "item": [ { "name": "company", "item": [ { "name": "get-performance-details", "item": [ { "name": "Company Get Performance Details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] }, "description": " This API endpoint can be used to get Awareness Training Mime | OS Training Module user level Performance details by Department and Performance Type (data displayed on Performance > Achievements Details). Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"department\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"numCorrect\": \"\",\n \"numIncorrect\": \"\",\n \"numNotWatched\": \"\",\n \"userDetails\": [\n {\n \"ack\": \"\",\n \"category\": \"\",\n \"status\": \"\",\n \"timeSent\": \"\",\n \"timeViewed\": \"\",\n \"title\": \"\"\n },\n {\n \"ack\": \"\",\n \"category\": \"\",\n \"status\": \"\",\n \"timeSent\": \"\",\n \"timeViewed\": \"\",\n \"title\": \"\"\n }\n ]\n },\n {\n \"department\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"numCorrect\": \"\",\n \"numIncorrect\": \"\",\n \"numNotWatched\": \"\",\n \"userDetails\": [\n {\n \"ack\": \"\",\n \"category\": \"\",\n \"status\": \"\",\n \"timeSent\": \"\",\n \"timeViewed\": \"\",\n \"title\": \"\"\n },\n {\n \"ack\": \"\",\n \"category\": \"\",\n \"status\": \"\",\n \"timeSent\": \"\",\n \"timeViewed\": \"\",\n \"title\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-details" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"includeUserDetails\": \"\",\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" } ] } ] }, { "name": "get-performance-summary", "item": [ { "name": "Company Get Performance Summary", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] }, "description": " This API endpoint can be used to get the Awareness Training Mime | OS Training Module company-level Performance Summary by total user answer count. (Data displayed on Performance > Achievements Dashboard) Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"departmentCompletionStats\": [\n {\n \"completedCount\": \"\",\n \"completedPercentage\": \"\",\n \"department\": \"\"\n },\n {\n \"completedCount\": \"\",\n \"completedPercentage\": \"\",\n \"department\": \"\"\n }\n ],\n \"numFourOrMoreIncorrect\": \"\",\n \"numOneIncorrect\": \"\",\n \"numParticipating\": \"\",\n \"numThreeIncorrect\": \"\",\n \"numTwoIncorrect\": \"\",\n \"numVideosNotWatched\": \"\",\n \"numVideosSent\": \"\",\n \"numZeroIncorrect\": \"\"\n },\n {\n \"departmentCompletionStats\": [\n {\n \"completedCount\": \"\",\n \"completedPercentage\": \"\",\n \"department\": \"\"\n },\n {\n \"completedCount\": \"\",\n \"completedPercentage\": \"\",\n \"department\": \"\"\n }\n ],\n \"numFourOrMoreIncorrect\": \"\",\n \"numOneIncorrect\": \"\",\n \"numParticipating\": \"\",\n \"numThreeIncorrect\": \"\",\n \"numTwoIncorrect\": \"\",\n \"numVideosNotWatched\": \"\",\n \"numVideosSent\": \"\",\n \"numZeroIncorrect\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-performance-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-performance-summary" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] }, { "name": "get-safe-score-details", "item": [ { "name": "Company Get Safe Score Details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] }, "description": " This API endpoint can be used to get Awareness Training Mime | OS SAFE Score user level details and grades, including User Risk, Human Error, Sentiment, Engagement and Knowledge. (Data displayed on Performance > User Risk Details) Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"department\": \"\",\n \"emailAddress\": \"\",\n \"engagement\": \"\",\n \"humanError\": \"\",\n \"knowledge\": \"\",\n \"name\": \"\",\n \"risk\": \"\",\n \"sentiment\": \"\"\n },\n {\n \"department\": \"\",\n \"emailAddress\": \"\",\n \"engagement\": \"\",\n \"humanError\": \"\",\n \"knowledge\": \"\",\n \"name\": \"\",\n \"risk\": \"\",\n \"sentiment\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-details" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" } ] } ] }, { "name": "get-safe-score-summary", "item": [ { "name": "Company Get Safe Score Summary", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] }, "description": " This API endpoint can be used to get Awareness Training Mime | OS Training SAFE Score company-level Summary by User Count per User Risk Grade. (Data displayed on Performance > User Risk Dashboard) Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"scoreCounts\": {}\n },\n {\n \"scoreCounts\": {}\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-safe-score-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-safe-score-summary" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] }, { "name": "get-watchlist-details", "item": [ { "name": "Company Get Watchlist Details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] }, "description": " This API endpoint can be used to get Awareness Training Mime | OS Training Module user level Watchlist details by Department and Watchlist Type. (Data displayed on Performance > Watchlist Details) Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"department\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"watchlistCount\": \"\"\n },\n {\n \"department\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"watchlistCount\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-details" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": [\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n },\n {\n \"attributeId\": \"\",\n \"fieldName\": \"\",\n \"value\": {}\n }\n ]\n }\n }\n ]\n}" } ] } ] }, { "name": "get-watchlist-summary", "item": [ { "name": "Company Get Watchlist Summary", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] }, "description": " This API endpoint can be used to get the Awareness Training Mime | OS Training Module company-level Watchlist Summary by total user unwatched count. (Data displayed on Performance > Watchlist Dashboard) Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"videoCountForAll\": {},\n \"videoCountFourOrMore\": {},\n \"videoCountOne\": {},\n \"videoCountThree\": {},\n \"videoCountTwo\": {}\n },\n {\n \"videoCountForAll\": {},\n \"videoCountFourOrMore\": {},\n \"videoCountOne\": {},\n \"videoCountThree\": {},\n \"videoCountTwo\": {}\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/company/get-watchlist-summary", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "company", "get-watchlist-summary" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] } ] }, { "name": "phishing", "item": [ { "name": "campaign", "item": [ { "name": "get-campaign", "item": [ { "name": "Campaign Get Campaign", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] }, "description": " This API endpoint can be used to get all campaign-level information on Awareness Training Mime | OS Phishing Campaigns created, both pending and launched. (Data displayed on Phishing > Campaigns) Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"id\": \"\",\n \"launchDate\": \"\",\n \"locale\": \"\",\n \"name\": \"\",\n \"numClicked\": \"\",\n \"numOpened\": \"\",\n \"numSent\": \"\",\n \"numSubmitted\": \"\",\n \"sender\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"templates\": [\n {\n \"displayTitle\": \"\",\n \"id\": \"\"\n },\n {\n \"displayTitle\": \"\",\n \"id\": \"\"\n }\n ],\n \"timeSlotSelected\": \"\"\n },\n {\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"id\": \"\",\n \"launchDate\": \"\",\n \"locale\": \"\",\n \"name\": \"\",\n \"numClicked\": \"\",\n \"numOpened\": \"\",\n \"numSent\": \"\",\n \"numSubmitted\": \"\",\n \"sender\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"templates\": [\n {\n \"displayTitle\": \"\",\n \"id\": \"\"\n },\n {\n \"displayTitle\": \"\",\n \"id\": \"\"\n }\n ],\n \"timeSlotSelected\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-campaign" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-user-data", "item": [ { "name": "Campaign Get User Data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] }, "description": " This API endpoint can be used to get an aggregated summary of Awareness Training Mime | OS Phishing Campaigns grouped by recipient email address. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"items\": [\n {\n \"department\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"numCampaignsClicked\": \"\",\n \"numCampaignsSent\": \"\",\n \"numCorrectAnswers\": \"\",\n \"numIncorrectAnswers\": \"\",\n \"numTrainingModulesAssigned\": \"\",\n \"reactionTime\": \"\",\n \"status\": \"\",\n \"templateName\": \"\",\n \"timeOpened\": \"\",\n \"timeSubmitted\": \"\"\n },\n {\n \"department\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"numCampaignsClicked\": \"\",\n \"numCampaignsSent\": \"\",\n \"numCorrectAnswers\": \"\",\n \"numIncorrectAnswers\": \"\",\n \"numTrainingModulesAssigned\": \"\",\n \"reactionTime\": \"\",\n \"status\": \"\",\n \"templateName\": \"\",\n \"timeOpened\": \"\",\n \"timeSubmitted\": \"\"\n }\n ]\n },\n {\n \"items\": [\n {\n \"department\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"numCampaignsClicked\": \"\",\n \"numCampaignsSent\": \"\",\n \"numCorrectAnswers\": \"\",\n \"numIncorrectAnswers\": \"\",\n \"numTrainingModulesAssigned\": \"\",\n \"reactionTime\": \"\",\n \"status\": \"\",\n \"templateName\": \"\",\n \"timeOpened\": \"\",\n \"timeSubmitted\": \"\"\n },\n {\n \"department\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"numCampaignsClicked\": \"\",\n \"numCampaignsSent\": \"\",\n \"numCorrectAnswers\": \"\",\n \"numIncorrectAnswers\": \"\",\n \"numTrainingModulesAssigned\": \"\",\n \"reactionTime\": \"\",\n \"status\": \"\",\n \"templateName\": \"\",\n \"timeOpened\": \"\",\n \"timeSubmitted\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/awareness-training/phishing/campaign/get-user-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "phishing", "campaign", "get-user-data" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"attributeIds\": [\n \"\",\n \"\"\n ],\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {}\n }\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "queue", "item": [ { "name": "get-queue", "item": [ { "name": "Queue Get Queue", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] }, "description": " This API endpoint can be used to get all module-level information on Awareness Training Mime | OS Training Modules created, both pending and launched. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"assignToNewUsers\": \"\",\n \"customAnswer\": {\n \"answerNumber\": \"\",\n \"correctAnswer\": \"\",\n \"safetyTip\": \"\"\n },\n \"customContentId\": \"\",\n \"customGifs\": {\n \"correctGif\": \"\",\n \"incorrectGif\": \"\"\n },\n \"emailCustomized\": \"\",\n \"emailMsg\": {\n \"body\": \"\",\n \"subject\": \"\"\n },\n \"id\": \"\",\n \"launchDate\": \"\",\n \"locked\": \"\",\n \"numCompleted\": \"\",\n \"numSent\": \"\",\n \"optionSpread\": {},\n \"title\": {\n \"correctAnswer\": \"\",\n \"defaultGifs\": {\n \"correctGif\": \"\",\n \"incorrectGif\": \"\"\n },\n \"id\": \"\",\n \"title\": \"\"\n }\n },\n {\n \"assignToNewUsers\": \"\",\n \"customAnswer\": {\n \"answerNumber\": \"\",\n \"correctAnswer\": \"\",\n \"safetyTip\": \"\"\n },\n \"customContentId\": \"\",\n \"customGifs\": {\n \"correctGif\": \"\",\n \"incorrectGif\": \"\"\n },\n \"emailCustomized\": \"\",\n \"emailMsg\": {\n \"body\": \"\",\n \"subject\": \"\"\n },\n \"id\": \"\",\n \"launchDate\": \"\",\n \"locked\": \"\",\n \"numCompleted\": \"\",\n \"numSent\": \"\",\n \"optionSpread\": {},\n \"title\": {\n \"correctAnswer\": \"\",\n \"defaultGifs\": {\n \"correctGif\": \"\",\n \"incorrectGif\": \"\"\n },\n \"id\": \"\",\n \"title\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/queue/get-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "queue", "get-queue" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] } ] }, { "name": "user", "item": [ { "name": "get-training-details", "item": [ { "name": "User Get Training Details", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] }, "description": " This API endpoint can be used to get user enrollment and completion information on Awareness Training Mime | OS Training Modules. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Awareness Training | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"meritBadge\": {},\n \"needEngagement\": \"\",\n \"trainings\": [\n {\n \"assignedTimeStamp\": \"\",\n \"myAnswer\": \"\",\n \"onWatchlist\": \"\",\n \"title\": \"\",\n \"titleId\": \"\",\n \"watched\": \"\",\n \"watchedDate\": \"\"\n },\n {\n \"assignedTimeStamp\": \"\",\n \"myAnswer\": \"\",\n \"onWatchlist\": \"\",\n \"title\": \"\",\n \"titleId\": \"\",\n \"watched\": \"\",\n \"watchedDate\": \"\"\n }\n ]\n },\n {\n \"meritBadge\": {},\n \"needEngagement\": \"\",\n \"trainings\": [\n {\n \"assignedTimeStamp\": \"\",\n \"myAnswer\": \"\",\n \"onWatchlist\": \"\",\n \"title\": \"\",\n \"titleId\": \"\",\n \"watched\": \"\",\n \"watchedDate\": \"\"\n },\n {\n \"assignedTimeStamp\": \"\",\n \"myAnswer\": \"\",\n \"onWatchlist\": \"\",\n \"title\": \"\",\n \"titleId\": \"\",\n \"watched\": \"\",\n \"watchedDate\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/awareness-training/user/get-training-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "awareness-training", "user", "get-training-details" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "email", "item": [ { "name": "get-email-queues", "item": [ { "name": "Email Get Email Queues", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] }, "description": " This endpoint can be used to get the count of the inbound and outbound email queues at specified times. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"inboundEmailQueue\": [\n {\n \"count\": \"\",\n \"date\": \"\"\n },\n {\n \"count\": \"\",\n \"date\": \"\"\n }\n ],\n \"outboundEmailQueue\": [\n {\n \"count\": \"\",\n \"date\": \"\"\n },\n {\n \"count\": \"\",\n \"date\": \"\"\n }\n ]\n },\n {\n \"inboundEmailQueue\": [\n {\n \"count\": \"\",\n \"date\": \"\"\n },\n {\n \"count\": \"\",\n \"date\": \"\"\n }\n ],\n \"outboundEmailQueue\": [\n {\n \"count\": \"\",\n \"date\": \"\"\n },\n {\n \"count\": \"\",\n \"date\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/get-email-queues", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "get-email-queues" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"start\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "send-email", "item": [ { "name": "Email Send Email", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] }, "description": " This API endpoint can be used to send an email. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"invalidRecipients\": [\n \"\",\n \"\"\n ],\n \"messageDateHeader\": \"\",\n \"messageId\": \"\"\n },\n {\n \"invalidRecipients\": [\n \"\",\n \"\"\n ],\n \"messageDateHeader\": \"\",\n \"messageId\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Binding Expired\tThe TTL of the access key and secret key issued on successful login has lapsed and the binding should be refreshed as described in the Understanding API Authentication guide.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "I'm a teapot (RFC 2324)", "code": 418, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/email/send-email", "host": [ "{{baseUrl}}" ], "path": [ "api", "email", "send-email" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"subject\": \"\",\n \"to\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"attachments\": [\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n },\n {\n \"size\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentId\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"filename\": \"\",\n \"id\": \"\"\n }\n ],\n \"bcc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"cc\": [\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n }\n ],\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": {\n \"emailAddress\": \"\",\n \"displayableName\": \"\"\n },\n \"htmlBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n },\n \"inReplyTo\": \"\",\n \"plainBody\": {\n \"charset\": \"\",\n \"content\": \"\",\n \"contentDisposition\": \"\",\n \"contentTransferEncoding\": \"\",\n \"contentType\": \"\",\n \"extraHeaders\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"id\": \"\"\n }\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "journaling", "item": [ { "name": "get-service", "item": [ { "name": "Journaling Get Service", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] }, "description": " This endpoint returns journaling connectors, their configuration and current status. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Journaling | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"enabled\": \"\",\n \"id\": \"\",\n \"journalNonInternalAddresses\": \"\",\n \"journalUnknownInternalAddresses\": \"\",\n \"messageFormat\": \"\",\n \"pop3JournalingConnection\": {\n \"detailedLoggingIsEnabled\": \"\",\n \"emailAddress\": \"\",\n \"encryptionIsRelaxed\": \"\",\n \"host\": \"\",\n \"mailbox\": \"\",\n \"port\": \"\",\n \"usesPOP3S\": \"\"\n },\n \"queueSize\": \"\",\n \"removeJournalHeaders\": \"\",\n \"smtpJournalingConnection\": {\n \"deliveryWaitAttempts\": \"\",\n \"emailAddress\": \"\",\n \"extendedDeduplication\": \"\",\n \"inactivityTimeout\": \"\",\n \"ipRanges\": [\n \"\",\n \"\"\n ],\n \"prefersClearText\": \"\",\n \"processInitialDelay\": \"\",\n \"usesAuthentication\": \"\",\n \"usesTls\": \"\"\n },\n \"statusInfo\": {\n \"id\": \"\",\n \"lastReceived\": \"\",\n \"queueSize\": \"\",\n \"status\": \"\"\n },\n \"transferProtocol\": \"\"\n },\n {\n \"description\": \"\",\n \"enabled\": \"\",\n \"id\": \"\",\n \"journalNonInternalAddresses\": \"\",\n \"journalUnknownInternalAddresses\": \"\",\n \"messageFormat\": \"\",\n \"pop3JournalingConnection\": {\n \"detailedLoggingIsEnabled\": \"\",\n \"emailAddress\": \"\",\n \"encryptionIsRelaxed\": \"\",\n \"host\": \"\",\n \"mailbox\": \"\",\n \"port\": \"\",\n \"usesPOP3S\": \"\"\n },\n \"queueSize\": \"\",\n \"removeJournalHeaders\": \"\",\n \"smtpJournalingConnection\": {\n \"deliveryWaitAttempts\": \"\",\n \"emailAddress\": \"\",\n \"extendedDeduplication\": \"\",\n \"inactivityTimeout\": \"\",\n \"ipRanges\": [\n \"\",\n \"\"\n ],\n \"prefersClearText\": \"\",\n \"processInitialDelay\": \"\",\n \"usesAuthentication\": \"\",\n \"usesTls\": \"\"\n },\n \"statusInfo\": {\n \"id\": \"\",\n \"lastReceived\": \"\",\n \"queueSize\": \"\",\n \"status\": \"\"\n },\n \"transferProtocol\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/journaling/get-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "journaling", "get-service" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "managedsender", "item": [ { "name": "permit-or-block-sender", "item": [ { "name": "Managedsender Permit Or Block Sender", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Managed Senders | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"sender\": \"\",\n \"to\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"sender\": \"\",\n \"to\": \"\",\n \"type\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"sender\": \"\",\n \"to\": \"\",\n \"action\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/managedsender/permit-or-block-sender", "host": [ "{{baseUrl}}" ], "path": [ "api", "managedsender", "permit-or-block-sender" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"\",\n \"sender\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "message-finder", "item": [ { "name": "get-message-info", "item": [ { "name": "Message Finder Get Message Info", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] }, "description": " This API endpoint can be used to retrieve detailed information about a specific message. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Tracking | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"deliveredMessage\": {\n \"ullamco6\": {\n \"messageInfo\": {\n \"attachments\": [\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n },\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n }\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"contentExpiration\": \"\",\n \"fromEnvelope\": \"\",\n \"fromHeader\": \"\",\n \"htmlBody\": \"\",\n \"metadataExpiration\": \"\",\n \"processed\": \"\",\n \"route\": \"\",\n \"sent\": \"\",\n \"subject\": \"\",\n \"textBody\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"transmissionInfo\": \"\"\n },\n \"policyInfo\": [\n {\n \"policyType\": \"\",\n \"policyName\": \"\",\n \"inherited\": \"\"\n },\n {\n \"policyType\": \"\",\n \"policyName\": \"\",\n \"inherited\": \"\"\n }\n ],\n \"deliveryMetaInfo\": {\n \"components\": [\n {\n \"extension\": \"\",\n \"hash\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"type\": \"\"\n },\n {\n \"extension\": \"\",\n \"hash\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"type\": \"\"\n }\n ],\n \"encryptionInfo\": \"\",\n \"messageExpiresIn\": \"\",\n \"processingServer\": \"\",\n \"receiptAcknowledgement\": \"\",\n \"remoteHost\": \"\",\n \"remoteIp\": \"\",\n \"remoteServerGreeting\": \"\",\n \"transmissionEnd\": \"\",\n \"transmissionSize\": \"\",\n \"transmissionStart\": \"\",\n \"transmissionDetails\": \"\",\n \"emailAddress\": \"\",\n \"deliveryEvent\": \"\"\n }\n },\n \"incididunt9c\": {\n \"messageInfo\": {\n \"attachments\": [\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n },\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n }\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"contentExpiration\": \"\",\n \"fromEnvelope\": \"\",\n \"fromHeader\": \"\",\n \"htmlBody\": \"\",\n \"metadataExpiration\": \"\",\n \"processed\": \"\",\n \"route\": \"\",\n \"sent\": \"\",\n \"subject\": \"\",\n \"textBody\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"transmissionInfo\": \"\"\n },\n \"policyInfo\": [\n {\n \"policyType\": \"\",\n \"policyName\": \"\",\n \"inherited\": \"\"\n },\n {\n \"policyType\": \"\",\n \"policyName\": \"\",\n \"inherited\": \"\"\n }\n ],\n \"deliveryMetaInfo\": {\n \"components\": [\n {\n \"extension\": \"\",\n \"hash\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"type\": \"\"\n },\n {\n \"extension\": \"\",\n \"hash\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"type\": \"\"\n }\n ],\n \"encryptionInfo\": \"\",\n \"messageExpiresIn\": \"\",\n \"processingServer\": \"\",\n \"receiptAcknowledgement\": \"\",\n \"remoteHost\": \"\",\n \"remoteIp\": \"\",\n \"remoteServerGreeting\": \"\",\n \"transmissionEnd\": \"\",\n \"transmissionSize\": \"\",\n \"transmissionStart\": \"\",\n \"transmissionDetails\": \"\",\n \"emailAddress\": \"\",\n \"deliveryEvent\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"recipientInfo\": {\n \"messageInfo\": {\n \"attachments\": [\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n },\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n }\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"contentExpiration\": \"\",\n \"fromEnvelope\": \"\",\n \"fromHeader\": \"\",\n \"htmlBody\": \"\",\n \"metadataExpiration\": \"\",\n \"processed\": \"\",\n \"route\": \"\",\n \"sent\": \"\",\n \"subject\": \"\",\n \"textBody\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"transmissionInfo\": \"\"\n }\n },\n \"retentionInfo\": {\n \"audits\": [\n {\n \"date\": \"\",\n \"info\": \"\",\n \"type\": \"\"\n },\n {\n \"date\": \"\",\n \"info\": \"\",\n \"type\": \"\"\n }\n ],\n \"currentPurgeDate\": \"\",\n \"fbrExpireCheck\": [\n \"\",\n \"\"\n ],\n \"fbrStamps\": [\n {\n \"address\": \"\",\n \"expire\": \"\",\n \"folder\": \"\",\n \"policy\": \"\",\n \"purge\": \"\",\n \"visibleToRecipient\": \"\"\n },\n {\n \"address\": \"\",\n \"expire\": \"\",\n \"folder\": \"\",\n \"policy\": \"\",\n \"purge\": \"\",\n \"visibleToRecipient\": \"\"\n }\n ],\n \"litigationHoldInfo\": [\n {\n \"expiryDate\": \"\",\n \"id\": \"\",\n \"legalHoldDescription\": \"\"\n },\n {\n \"expiryDate\": \"\",\n \"id\": \"\",\n \"legalHoldDescription\": \"\"\n }\n ],\n \"originalPurgeDate\": \"\",\n \"purgeBasedOn\": \"\",\n \"retentionAdjustmentDays\": \"\",\n \"smartTags\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ]\n },\n \"spamInfo\": {\n \"detectionLevel\": \"\",\n \"spamProcessingDetail\": {\n \"dkim\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"dmarc\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"greyEmail\": \"\",\n \"managedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"permittedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"rbl\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"spf\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"verdict\": {\n \"categories\": [\n \"\",\n \"\"\n ],\n \"decision\": \"\",\n \"description\": \"\",\n \"risk\": \"\"\n }\n },\n \"spamScore\": \"\"\n },\n \"status\": \"\"\n },\n {\n \"deliveredMessage\": {\n \"culpa_0e\": {\n \"messageInfo\": {\n \"attachments\": [\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n },\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n }\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"contentExpiration\": \"\",\n \"fromEnvelope\": \"\",\n \"fromHeader\": \"\",\n \"htmlBody\": \"\",\n \"metadataExpiration\": \"\",\n \"processed\": \"\",\n \"route\": \"\",\n \"sent\": \"\",\n \"subject\": \"\",\n \"textBody\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"transmissionInfo\": \"\"\n },\n \"policyInfo\": [\n {\n \"policyType\": \"\",\n \"policyName\": \"\",\n \"inherited\": \"\"\n },\n {\n \"policyType\": \"\",\n \"policyName\": \"\",\n \"inherited\": \"\"\n }\n ],\n \"deliveryMetaInfo\": {\n \"components\": [\n {\n \"extension\": \"\",\n \"hash\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"type\": \"\"\n },\n {\n \"extension\": \"\",\n \"hash\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"type\": \"\"\n }\n ],\n \"encryptionInfo\": \"\",\n \"messageExpiresIn\": \"\",\n \"processingServer\": \"\",\n \"receiptAcknowledgement\": \"\",\n \"remoteHost\": \"\",\n \"remoteIp\": \"\",\n \"remoteServerGreeting\": \"\",\n \"transmissionEnd\": \"\",\n \"transmissionSize\": \"\",\n \"transmissionStart\": \"\",\n \"transmissionDetails\": \"\",\n \"emailAddress\": \"\",\n \"deliveryEvent\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"recipientInfo\": {\n \"messageInfo\": {\n \"attachments\": [\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n },\n {\n \"bodyType\": \"\",\n \"contentId\": \"\",\n \"contentType\": \"\",\n \"extension\": \"\",\n \"filename\": \"\",\n \"id\": {},\n \"md5\": \"\",\n \"scanDate\": \"\",\n \"sha256\": \"\",\n \"size\": \"\",\n \"verdict\": \"\"\n }\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"contentExpiration\": \"\",\n \"fromEnvelope\": \"\",\n \"fromHeader\": \"\",\n \"htmlBody\": \"\",\n \"metadataExpiration\": \"\",\n \"processed\": \"\",\n \"route\": \"\",\n \"sent\": \"\",\n \"subject\": \"\",\n \"textBody\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"transmissionInfo\": \"\"\n }\n },\n \"retentionInfo\": {\n \"audits\": [\n {\n \"date\": \"\",\n \"info\": \"\",\n \"type\": \"\"\n },\n {\n \"date\": \"\",\n \"info\": \"\",\n \"type\": \"\"\n }\n ],\n \"currentPurgeDate\": \"\",\n \"fbrExpireCheck\": [\n \"\",\n \"\"\n ],\n \"fbrStamps\": [\n {\n \"address\": \"\",\n \"expire\": \"\",\n \"folder\": \"\",\n \"policy\": \"\",\n \"purge\": \"\",\n \"visibleToRecipient\": \"\"\n },\n {\n \"address\": \"\",\n \"expire\": \"\",\n \"folder\": \"\",\n \"policy\": \"\",\n \"purge\": \"\",\n \"visibleToRecipient\": \"\"\n }\n ],\n \"litigationHoldInfo\": [\n {\n \"expiryDate\": \"\",\n \"id\": \"\",\n \"legalHoldDescription\": \"\"\n },\n {\n \"expiryDate\": \"\",\n \"id\": \"\",\n \"legalHoldDescription\": \"\"\n }\n ],\n \"originalPurgeDate\": \"\",\n \"purgeBasedOn\": \"\",\n \"retentionAdjustmentDays\": \"\",\n \"smartTags\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ]\n },\n \"spamInfo\": {\n \"detectionLevel\": \"\",\n \"spamProcessingDetail\": {\n \"dkim\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"dmarc\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"greyEmail\": \"\",\n \"managedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"permittedSender\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"rbl\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"spf\": {\n \"allow\": \"\",\n \"info\": \"\"\n },\n \"verdict\": {\n \"categories\": [\n \"\",\n \"\"\n ],\n \"decision\": \"\",\n \"description\": \"\",\n \"risk\": \"\"\n }\n },\n \"spamScore\": \"\"\n },\n \"status\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/get-message-info", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "get-message-info" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "search", "item": [ { "name": "Message Finder Search", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Tracking | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"trackedEmails\": [\n {\n \"attachments\": \"\",\n \"detectionLevel\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHdr\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"info\": \"\",\n \"received\": \"\",\n \"route\": \"\",\n \"senderIP\": \"\",\n \"sent\": \"\",\n \"spamScore\": \"\",\n \"spamVerdict\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n },\n {\n \"attachments\": \"\",\n \"detectionLevel\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHdr\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"info\": \"\",\n \"received\": \"\",\n \"route\": \"\",\n \"senderIP\": \"\",\n \"sent\": \"\",\n \"spamScore\": \"\",\n \"spamVerdict\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"trackedEmails\": [\n {\n \"attachments\": \"\",\n \"detectionLevel\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHdr\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"info\": \"\",\n \"received\": \"\",\n \"route\": \"\",\n \"senderIP\": \"\",\n \"sent\": \"\",\n \"spamScore\": \"\",\n \"spamVerdict\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n },\n {\n \"attachments\": \"\",\n \"detectionLevel\": \"\",\n \"fromEnv\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"fromHdr\": {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n \"id\": \"\",\n \"info\": \"\",\n \"received\": \"\",\n \"route\": \"\",\n \"senderIP\": \"\",\n \"sent\": \"\",\n \"spamScore\": \"\",\n \"spamVerdict\": \"\",\n \"status\": \"\",\n \"subject\": \"\",\n \"to\": [\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"displayableName\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"bulk_delivery\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"rejected\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"internal\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"outbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"held\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"internal\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"outbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"held\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"internal\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"outbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"held\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"internal\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"outbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"held\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"internal\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"outbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"held\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"internal\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"outbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"held\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"inbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/message-finder/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "message-finder", "search" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"internal\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"accepted\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"advancedTrackAndTraceOptions\": {\n \"from\": \"\",\n \"senderIP\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"url\": \"\"\n },\n \"attachments\": \"\",\n \"end\": \"\",\n \"messageId\": \"\",\n \"route\": \"outbound\",\n \"searchReason\": \"\",\n \"start\": \"\",\n \"status\": \"held\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "ttp", "item": [ { "name": "url", "item": [ { "name": "decode-url", "item": [ { "name": "Url Decode Url", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"success\": \"\",\n \"url\": \"\"\n },\n {\n \"success\": \"\",\n \"url\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/decode-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "decode-url" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"url\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "create-managed-url", "item": [ { "name": "Url Create Managed Url", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] }, "description": " This endpoint can be used to add new managed URL entries for URL Protection. The common actions are to manually block or permit a URL, however additional options include the ability to disable URL rewriting and bypassing User Awareness. Note: Each account has a maximum URL entry limit, which can be reached more quickly when automating the addition of URLs. To get more information on your account’s current limit, please reach out to your Customer Success Manager, or your regional Customer Success Desk. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Targeted Threat Protection - URL Protect | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"whitelist\": \"\"\n },\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"matchType\": {\n \"matchType\": {\n \"id\": \"\",\n \"name\": \"\",\n \"ordinal\": \"\"\n },\n \"name\": \"\",\n \"ordinal\": \"\"\n },\n \"path\": \"\",\n \"port\": \"\",\n \"queryString\": \"\",\n \"scheme\": \"\"\n },\n {\n \"action\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"whitelist\": \"\"\n },\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"matchType\": {\n \"matchType\": {\n \"id\": \"\",\n \"name\": \"\",\n \"ordinal\": \"\"\n },\n \"name\": \"\",\n \"ordinal\": \"\"\n },\n \"path\": \"\",\n \"port\": \"\",\n \"queryString\": \"\",\n \"scheme\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"unknown\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"unknown\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"domain\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"unknown\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"domain\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"unknown\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"domain\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"unknown\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"domain\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"unknown\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"domain\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"unknown\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"domain\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"action\": \"block\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"explicit\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/create-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "create-managed-url" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"unknown\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"action\": \"permit\",\n \"url\": \"\",\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"matchType\": \"domain\"\n }\n }\n ]\n}" } ] } ] }, { "name": "delete-managed-url", "item": [ { "name": "Url Delete Managed Url", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] }, "description": " This API endpoint allows for the removal of an existing Managed URL entry. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | URL Protection | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [ { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [ { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/delete-managed-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "delete-managed-url" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "" } ] } ] }, { "name": "get-all-managed-urls", "item": [ { "name": "Url Get All Managed Urls", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] }, "description": " This endpoint can be used to return all entries currently in an accounts Managed URL list. Optional filtering fields can also be used to return a specific URL, or set of URLs. Note: Each account has a maximum URL entry limit. To get more information on your accounts current limit, please reach out to your Customer Success Manager, or your regional Customer Success Desk. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Targeted Threat Protection - URL Protect | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"action\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"whitelist\": \"\"\n },\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"matchType\": {\n \"matchType\": {\n \"id\": \"\",\n \"name\": \"\",\n \"ordinal\": \"\"\n },\n \"name\": \"\",\n \"ordinal\": \"\"\n },\n \"path\": \"\",\n \"port\": \"\",\n \"queryString\": \"\",\n \"scheme\": \"\"\n },\n {\n \"action\": {\n \"name\": \"\",\n \"ordinal\": \"\",\n \"whitelist\": \"\"\n },\n \"comment\": \"\",\n \"disableLogClick\": \"\",\n \"disableRewrite\": \"\",\n \"disableUserAwareness\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"matchType\": {\n \"matchType\": {\n \"id\": \"\",\n \"name\": \"\",\n \"ordinal\": \"\"\n },\n \"name\": \"\",\n \"ordinal\": \"\"\n },\n \"path\": \"\",\n \"port\": \"\",\n \"queryString\": \"\",\n \"scheme\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-all-managed-urls", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-all-managed-urls" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"asc\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domainOrComment\": \"\",\n \"domainOrUrl\": \"\",\n \"exactMatch\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"sortByUrl\": \"\",\n \"sortOrder\": \"desc\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-logs", "item": [ { "name": "Url Get Logs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Monitoring | URL Protection | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"clickLogs\": [\n {\n \"action\": \"\",\n \"actions\": \"\",\n \"adminOverride\": \"\",\n \"advancedPhishingResult\": {},\n \"category\": \"\",\n \"creationMethod\": \"\",\n \"date\": \"\",\n \"emailPartsDescription\": [\n \"\",\n \"\"\n ],\n \"fromUserEmailAddress\": \"\",\n \"heuristicDomainSource\": \"\",\n \"messageId\": \"\",\n \"route\": \"\",\n \"scanResult\": \"\",\n \"sendingIp\": \"\",\n \"similarDomain\": \"\",\n \"subject\": \"\",\n \"tagMap\": {},\n \"ttpDefinition\": \"\",\n \"url\": \"\",\n \"userAwarenessAction\": \"\",\n \"userEmailAddress\": \"\",\n \"userOverride\": \"\"\n },\n {\n \"action\": \"\",\n \"actions\": \"\",\n \"adminOverride\": \"\",\n \"advancedPhishingResult\": {},\n \"category\": \"\",\n \"creationMethod\": \"\",\n \"date\": \"\",\n \"emailPartsDescription\": [\n \"\",\n \"\"\n ],\n \"fromUserEmailAddress\": \"\",\n \"heuristicDomainSource\": \"\",\n \"messageId\": \"\",\n \"route\": \"\",\n \"scanResult\": \"\",\n \"sendingIp\": \"\",\n \"similarDomain\": \"\",\n \"subject\": \"\",\n \"tagMap\": {},\n \"ttpDefinition\": \"\",\n \"url\": \"\",\n \"userAwarenessAction\": \"\",\n \"userEmailAddress\": \"\",\n \"userOverride\": \"\"\n }\n ]\n },\n {\n \"clickLogs\": [\n {\n \"action\": \"\",\n \"actions\": \"\",\n \"adminOverride\": \"\",\n \"advancedPhishingResult\": {},\n \"category\": \"\",\n \"creationMethod\": \"\",\n \"date\": \"\",\n \"emailPartsDescription\": [\n \"\",\n \"\"\n ],\n \"fromUserEmailAddress\": \"\",\n \"heuristicDomainSource\": \"\",\n \"messageId\": \"\",\n \"route\": \"\",\n \"scanResult\": \"\",\n \"sendingIp\": \"\",\n \"similarDomain\": \"\",\n \"subject\": \"\",\n \"tagMap\": {},\n \"ttpDefinition\": \"\",\n \"url\": \"\",\n \"userAwarenessAction\": \"\",\n \"userEmailAddress\": \"\",\n \"userOverride\": \"\"\n },\n {\n \"action\": \"\",\n \"actions\": \"\",\n \"adminOverride\": \"\",\n \"advancedPhishingResult\": {},\n \"category\": \"\",\n \"creationMethod\": \"\",\n \"date\": \"\",\n \"emailPartsDescription\": [\n \"\",\n \"\"\n ],\n \"fromUserEmailAddress\": \"\",\n \"heuristicDomainSource\": \"\",\n \"messageId\": \"\",\n \"route\": \"\",\n \"scanResult\": \"\",\n \"sendingIp\": \"\",\n \"similarDomain\": \"\",\n \"subject\": \"\",\n \"tagMap\": {},\n \"ttpDefinition\": \"\",\n \"url\": \"\",\n \"userAwarenessAction\": \"\",\n \"userEmailAddress\": \"\",\n \"userOverride\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"suspicious\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"internal\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"internal\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"inbound\",\n \"scanResult\": \"clean\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"internal\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"inbound\",\n \"scanResult\": \"clean\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"internal\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"inbound\",\n \"scanResult\": \"clean\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"internal\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"inbound\",\n \"scanResult\": \"clean\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"internal\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"inbound\",\n \"scanResult\": \"clean\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"internal\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"inbound\",\n \"scanResult\": \"clean\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"all\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/url/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "url", "get-logs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"internal\",\n \"scanResult\": \"malicious\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"route\": \"inbound\",\n \"scanResult\": \"clean\",\n \"to\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "attachment", "item": [ { "name": "get-logs", "item": [ { "name": "Attachment Get Logs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] }, "description": " Pre-requisites In order to to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Monitoring | Attachment Protection | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"attachmentLogs\": [\n {\n \"actionTriggered\": \"\",\n \"date\": \"\",\n \"definition\": \"\",\n \"details\": \"\",\n \"fileHash\": \"\",\n \"fileName\": \"\",\n \"fileType\": \"\",\n \"messageId\": \"\",\n \"recipientAddress\": \"\",\n \"result\": \"\",\n \"route\": \"\",\n \"senderAddress\": \"\",\n \"subject\": \"\"\n },\n {\n \"actionTriggered\": \"\",\n \"date\": \"\",\n \"definition\": \"\",\n \"details\": \"\",\n \"fileHash\": \"\",\n \"fileName\": \"\",\n \"fileType\": \"\",\n \"messageId\": \"\",\n \"recipientAddress\": \"\",\n \"result\": \"\",\n \"route\": \"\",\n \"senderAddress\": \"\",\n \"subject\": \"\"\n }\n ]\n },\n {\n \"attachmentLogs\": [\n {\n \"actionTriggered\": \"\",\n \"date\": \"\",\n \"definition\": \"\",\n \"details\": \"\",\n \"fileHash\": \"\",\n \"fileName\": \"\",\n \"fileType\": \"\",\n \"messageId\": \"\",\n \"recipientAddress\": \"\",\n \"result\": \"\",\n \"route\": \"\",\n \"senderAddress\": \"\",\n \"subject\": \"\"\n },\n {\n \"actionTriggered\": \"\",\n \"date\": \"\",\n \"definition\": \"\",\n \"details\": \"\",\n \"fileHash\": \"\",\n \"fileName\": \"\",\n \"fileType\": \"\",\n \"messageId\": \"\",\n \"recipientAddress\": \"\",\n \"result\": \"\",\n \"route\": \"\",\n \"senderAddress\": \"\",\n \"subject\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"internal\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"error\",\n \"route\": \"internal\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"safe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"all\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"safe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"all\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"safe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"all\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"safe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"all\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"safe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"all\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"safe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"all\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"unsafe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/attachment/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "attachment", "get-logs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"safe\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"result\": \"all\",\n \"route\": \"all\",\n \"to\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "impersonation", "item": [ { "name": "get-logs", "item": [ { "name": "Impersonation Get Logs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] }, "description": " This endpoint can be used to get messages containing information flagged by an Impersonation Protection configuration. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Monitoring | Impersonation Protection | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"impersonationLogs\": [\n {\n \"action\": \"\",\n \"definition\": \"\",\n \"eventTime\": \"\",\n \"hits\": \"\",\n \"id\": \"\",\n \"identifiers\": [\n \"\",\n \"\"\n ],\n \"impersonationResults\": [\n {\n \"checkerResult\": \"\",\n \"enhancedResults\": [\n \"\",\n \"\"\n ],\n \"impersonationDomainSource\": \"\",\n \"similarDomain\": \"\",\n \"stringSimilarToDomain\": \"\"\n },\n {\n \"checkerResult\": \"\",\n \"enhancedResults\": [\n \"\",\n \"\"\n ],\n \"impersonationDomainSource\": \"\",\n \"similarDomain\": \"\",\n \"stringSimilarToDomain\": \"\"\n }\n ],\n \"messageId\": \"\",\n \"recipientAddress\": \"\",\n \"senderAddress\": \"\",\n \"senderIpAddress\": \"\",\n \"subject\": \"\",\n \"taggedExternal\": \"\",\n \"taggedMalicious\": \"\"\n },\n {\n \"action\": \"\",\n \"definition\": \"\",\n \"eventTime\": \"\",\n \"hits\": \"\",\n \"id\": \"\",\n \"identifiers\": [\n \"\",\n \"\"\n ],\n \"impersonationResults\": [\n {\n \"checkerResult\": \"\",\n \"enhancedResults\": [\n \"\",\n \"\"\n ],\n \"impersonationDomainSource\": \"\",\n \"similarDomain\": \"\",\n \"stringSimilarToDomain\": \"\"\n },\n {\n \"checkerResult\": \"\",\n \"enhancedResults\": [\n \"\",\n \"\"\n ],\n \"impersonationDomainSource\": \"\",\n \"similarDomain\": \"\",\n \"stringSimilarToDomain\": \"\"\n }\n ],\n \"messageId\": \"\",\n \"recipientAddress\": \"\",\n \"senderAddress\": \"\",\n \"senderIpAddress\": \"\",\n \"subject\": \"\",\n \"taggedExternal\": \"\",\n \"taggedMalicious\": \"\"\n }\n ],\n \"resultCount\": \"\"\n },\n {\n \"impersonationLogs\": [\n {\n \"action\": \"\",\n \"definition\": \"\",\n \"eventTime\": \"\",\n \"hits\": \"\",\n \"id\": \"\",\n \"identifiers\": [\n \"\",\n \"\"\n ],\n \"impersonationResults\": [\n {\n \"checkerResult\": \"\",\n \"enhancedResults\": [\n \"\",\n \"\"\n ],\n \"impersonationDomainSource\": \"\",\n \"similarDomain\": \"\",\n \"stringSimilarToDomain\": \"\"\n },\n {\n \"checkerResult\": \"\",\n \"enhancedResults\": [\n \"\",\n \"\"\n ],\n \"impersonationDomainSource\": \"\",\n \"similarDomain\": \"\",\n \"stringSimilarToDomain\": \"\"\n }\n ],\n \"messageId\": \"\",\n \"recipientAddress\": \"\",\n \"senderAddress\": \"\",\n \"senderIpAddress\": \"\",\n \"subject\": \"\",\n \"taggedExternal\": \"\",\n \"taggedMalicious\": \"\"\n },\n {\n \"action\": \"\",\n \"definition\": \"\",\n \"eventTime\": \"\",\n \"hits\": \"\",\n \"id\": \"\",\n \"identifiers\": [\n \"\",\n \"\"\n ],\n \"impersonationResults\": [\n {\n \"checkerResult\": \"\",\n \"enhancedResults\": [\n \"\",\n \"\"\n ],\n \"impersonationDomainSource\": \"\",\n \"similarDomain\": \"\",\n \"stringSimilarToDomain\": \"\"\n },\n {\n \"checkerResult\": \"\",\n \"enhancedResults\": [\n \"\",\n \"\"\n ],\n \"impersonationDomainSource\": \"\",\n \"similarDomain\": \"\",\n \"stringSimilarToDomain\": \"\"\n }\n ],\n \"messageId\": \"\",\n \"recipientAddress\": \"\",\n \"senderAddress\": \"\",\n \"senderIpAddress\": \"\",\n \"subject\": \"\",\n \"taggedExternal\": \"\",\n \"taggedMalicious\": \"\"\n }\n ],\n \"resultCount\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"hold\",\n \"from\": \"\",\n \"identifiers\": \"newly_observed_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"recipientAddress\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"none\",\n \"from\": \"\",\n \"identifiers\": \"custom_name_list\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"definition\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"all\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"all\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"all\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"all\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"all\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"all\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"mimecast_external_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/impersonation/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "impersonation", "get-logs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"all\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"identifiers\": \"similar_internal_domain\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"searchField\": \"subject\",\n \"taggedMalicious\": \"\",\n \"to\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "remediation", "item": [ { "name": "create", "item": [ { "name": "Remediation Create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] }, "description": " This endpoint can be used to create a remediation incident, by messageId, file hash or a url contained in an email. A successful call will return the incident information, and will take the same actions as a manual remediation incident created in the Administration Console. Note: Currently this endpoint does not support image file hashes. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Threat Remediation | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"create\": \"\",\n \"failed\": \"\",\n \"fileRemediationCanBeCancelled\": \"\",\n \"fileRemediationCancelled\": \"\",\n \"fileRemediationExpiryTime\": \"\",\n \"identified\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"remediatedBy\": \"\",\n \"removeFromDevice\": \"\",\n \"restored\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"from\": \"\",\n \"messageId\": \"\",\n \"restoreCode\": \"\",\n \"start\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"unremediateCode\": \"\",\n \"url\": \"\"\n },\n \"successful\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"create\": \"\",\n \"failed\": \"\",\n \"fileRemediationCanBeCancelled\": \"\",\n \"fileRemediationCancelled\": \"\",\n \"fileRemediationExpiryTime\": \"\",\n \"identified\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"remediatedBy\": \"\",\n \"removeFromDevice\": \"\",\n \"restored\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"from\": \"\",\n \"messageId\": \"\",\n \"restoreCode\": \"\",\n \"start\": \"\",\n \"subject\": \"\",\n \"to\": \"\",\n \"unremediateCode\": \"\",\n \"url\": \"\"\n },\n \"successful\": \"\",\n \"type\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"messageId\",\n \"start\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "create" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"reason\": \"\",\n \"end\": \"\",\n \"hashOrMessageId\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "v2", "item": [ { "name": "create", "item": [ { "name": "V2 Create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] }, "description": " This endpoint can be used to create a remediation incident, by file hash or a url of by one or more messageId. A successful call will return the incident information, and will take the same actions as a manual remediation incident created in the Administration Console. Note: Currently this endpoint does not support image file hashes. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Threat Remediation | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"code\": \"\",\n \"create\": \"\",\n \"id\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"remediatedBy\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"url\": \"\"\n },\n \"type\": \"\"\n },\n {\n \"code\": \"\",\n \"create\": \"\",\n \"id\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"remediatedBy\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"url\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"reason\": \"\",\n \"searchBy\": \"message_ids\",\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/v2/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "v2", "create" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"reason\": \"\",\n \"searchBy\": \"hash\",\n \"start\": \"\",\n \"hash\": \"\",\n \"url\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "find-incidents", "item": [ { "name": "Remediation Find Incidents", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] }, "description": " This endpoint can be used to search for existing remediation incidents. While each request field is optional, at least one field must be supplied. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Threat Remediation | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"incidents\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"create\": \"\",\n \"failed\": \"\",\n \"identified\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"restored\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"from\": \"\",\n \"messageId\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"restoreCode\": \"\",\n \"start\": \"\",\n \"to\": \"\",\n \"unremediateCode\": \"\"\n },\n \"successful\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"create\": \"\",\n \"failed\": \"\",\n \"identified\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"restored\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"from\": \"\",\n \"messageId\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"restoreCode\": \"\",\n \"start\": \"\",\n \"to\": \"\",\n \"unremediateCode\": \"\"\n },\n \"successful\": \"\",\n \"type\": \"\"\n }\n ]\n },\n {\n \"incidents\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"create\": \"\",\n \"failed\": \"\",\n \"identified\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"restored\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"from\": \"\",\n \"messageId\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"restoreCode\": \"\",\n \"start\": \"\",\n \"to\": \"\",\n \"unremediateCode\": \"\"\n },\n \"successful\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"create\": \"\",\n \"failed\": \"\",\n \"identified\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"restored\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"from\": \"\",\n \"messageId\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"restoreCode\": \"\",\n \"start\": \"\",\n \"to\": \"\",\n \"unremediateCode\": \"\"\n },\n \"successful\": \"\",\n \"type\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/find-incidents", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "find-incidents" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"end\": \"\",\n \"filterBy\": [\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"value\": \"\"\n }\n ],\n \"searchBy\": {\n \"fieldName\": \"\",\n \"value\": \"\"\n },\n \"start\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-incident", "item": [ { "name": "Remediation Get Incident", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] }, "description": " This endpoint can be used to get information about an existing incident. The information includes incident creation criteria, remediation status counts and information to restore a message, if needed. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Threat Remediation | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"code\": \"\",\n \"create\": \"\",\n \"failed\": \"\",\n \"identified\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"restored\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"from\": \"\",\n \"messageId\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"restoreCode\": \"\",\n \"start\": \"\",\n \"to\": \"\",\n \"unremediateCode\": \"\"\n },\n \"successful\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"code\": \"\",\n \"create\": \"\",\n \"failed\": \"\",\n \"identified\": \"\",\n \"modified\": \"\",\n \"reason\": \"\",\n \"restored\": \"\",\n \"searchCriteria\": {\n \"end\": \"\",\n \"fileHash\": \"\",\n \"from\": \"\",\n \"messageId\": \"\",\n \"messageIds\": [\n \"\",\n \"\"\n ],\n \"restoreCode\": \"\",\n \"start\": \"\",\n \"to\": \"\",\n \"unremediateCode\": \"\"\n },\n \"successful\": \"\",\n \"type\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/get-incident", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "get-incident" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "search-hash", "item": [ { "name": "Remediation Search Hash", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] }, "description": " This endpoint can be used to identify if an account has seen a specific file hash within messages over the last year. A maximum of 100 hashes can be submitted in a single call, however we recommend submitting no more than 20 hashes per API call to stay under the 2048 byte size limit. Note: Currently this endpoint does not support image file hashes. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Threat Remediation | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"failedHashes\": [\n \"\",\n \"\"\n ],\n \"hashStatus\": [\n {\n \"detected\": \"\",\n \"hash\": \"\"\n },\n {\n \"detected\": \"\",\n \"hash\": \"\"\n }\n ]\n },\n {\n \"failedHashes\": [\n \"\",\n \"\"\n ],\n \"hashStatus\": [\n {\n \"detected\": \"\",\n \"hash\": \"\"\n },\n {\n \"detected\": \"\",\n \"hash\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/ttp/remediation/search-hash", "host": [ "{{baseUrl}}" ], "path": [ "api", "ttp", "remediation", "search-hash" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashes\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "file", "item": [ { "name": "file-upload", "item": [ { "name": "File File Upload", "request": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] }, "description": " This API endpoint can be used to upload a file to attach and send in email. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Dashboard | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"meta\": {\n \"status\": \"\"\n },\n \"data\": [\n {\n \"urls\": [\n \"\"\n ]\n },\n {\n \"urls\": [\n \"\"\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Binding Expired\tThe TTL of the access key and secret key issued on successful login has lapsed and the binding should be refreshed as described in the Understanding API Authentication guide.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "I'm a teapot (RFC 2324)", "code": 418, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"admin\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "Lorem pariatur eiusmod culpa in", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"sha256\":\"String\", \"fileSize\":31232 } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/file/file-upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "file", "file-upload" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" } ] } ] } ] }, { "name": "domain", "item": [ { "name": "create-domain", "item": [ { "name": "Domain Create Domain", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] }, "description": " This endpoint can be used to add new domains to your Mimecast account. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Register New Domain . Notes This endpoint initiates registration of a new domain with Mimecast and returns a code for the domain owner to add as a TXT record to the domain. This enables Mimecast to verify ownership of the domain. If the requested domain is already managed by any account, it will NOT be registered again. If the domain's parent domain is managed by the same account, the domain will be registered as an internal domain without a verification code. If the parent domain is managed by a different account, the domain will NOT be registered. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"created\": \"\",\n \"domain\": \"\",\n \"expiry\": \"\",\n \"id\": \"\",\n \"token\": \"\"\n },\n {\n \"created\": \"\",\n \"domain\": \"\",\n \"expiry\": \"\",\n \"id\": \"\",\n \"token\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"smtp\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/create-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "create-domain" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" } ] } ] }, { "name": "delete-pending-domain", "item": [ { "name": "Domain Delete Pending Domain", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Register New Domain . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"deleted\": \"\",\n \"domain\": \"\"\n },\n {\n \"deleted\": \"\",\n \"domain\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/delete-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "delete-pending-domain" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-internal-domain", "item": [ { "name": "Domain Get Internal Domain", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"id\": \"\",\n \"inboundType\": \"\",\n \"local\": \"\",\n \"sendOnly\": \"\"\n },\n {\n \"domain\": \"\",\n \"id\": \"\",\n \"inboundType\": \"\",\n \"local\": \"\",\n \"sendOnly\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-internal-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-internal-domain" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-pending-domain", "item": [ { "name": "Domain Get Pending Domain", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Register New Domain . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"created\": \"\",\n \"domain\": \"\",\n \"expiry\": \"\",\n \"id\": \"\",\n \"token\": \"\"\n },\n {\n \"created\": \"\",\n \"domain\": \"\",\n \"expiry\": \"\",\n \"id\": \"\",\n \"token\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-pending-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-pending-domain" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-provision-status", "item": [ { "name": "Domain Get Provision Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Register New Domain . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"managed\": \"\",\n \"provisioned\": \"\"\n },\n {\n \"domain\": \"\",\n \"managed\": \"\",\n \"provisioned\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-provision-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-provision-status" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-verification-code", "item": [ { "name": "Domain Get Verification Code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Register New Domain . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"token\": \"\"\n },\n {\n \"domain\": \"\",\n \"token\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/get-verification-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "get-verification-code" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "verify-domain", "item": [ { "name": "Domain Verify Domain", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] }, "description": " Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Register New Domain . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"status\": \"\"\n },\n {\n \"domain\": \"\",\n \"status\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"smtp\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\",\n \"inboundType\": \"ldap\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/domain/verify-domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "domain", "verify-domain" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"known\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"inboundType\": \"any\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "policy", "item": [ { "name": "address-alteration", "item": [ { "name": "create-address-alteration-set", "item": [ { "name": "Address Alteration Create Address Alteration Set", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] }, "description": " This API endpoint can be used to create new Address Alteration Set, to hold a number of alteration definitions. Pre-requisites In In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-address-alteration-set" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "create-definition", "item": [ { "name": "Address Alteration Create Definition", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] }, "description": " This API endpoint can be used to create new Address Alteration definitions within an Address Alteration Set or at the root level for policy-less processing. Currently, the records created via API call are limited to 3000. Additional records can be created within the Administration Console. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"success\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"all\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"all\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ],\n \"folderId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"all\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n },\n {\n \"addressType\": \"all\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n },\n {\n \"addressType\": \"sender\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n }\n ],\n \"folderId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"to_cc_bcc\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n },\n {\n \"addressType\": \"sender\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n }\n ],\n \"folderId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"to_cc_bcc\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n },\n {\n \"addressType\": \"sender\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n }\n ],\n \"folderId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"to_cc_bcc\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n },\n {\n \"addressType\": \"sender\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n }\n ],\n \"folderId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"to_cc_bcc\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n },\n {\n \"addressType\": \"sender\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n }\n ],\n \"folderId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"to_cc_bcc\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n },\n {\n \"addressType\": \"sender\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n }\n ],\n \"folderId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"to_cc_bcc\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_to\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-definition" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n },\n {\n \"addressType\": \"sender\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n }\n ],\n \"folderId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterations\": [\n {\n \"addressType\": \"to_cc_bcc\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n },\n {\n \"addressType\": \"envelope_from\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n ],\n \"folderId\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "create-policy", "item": [ { "name": "Address Alteration Create Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] }, "description": " This API endpoint can be used to create new Address Alteration policy to apply an alteration definition based on sender and recipient values. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"id\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"any_shared_drive\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"addressAlterationSetId\": \"\",\n \"id\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "create-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" } ] } ] }, { "name": "delete-definition", "item": [ { "name": "Address Alteration Delete Definition", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] }, "description": " This API endpoint can be used to remove an existing Address Alteration definitions within an Address Alteration Set. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"success\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-definition" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "delete-policy", "item": [ { "name": "Address Alteration Delete Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] }, "description": " This API endpoint can be used to remove an existing Address Alteration policy. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"deleted\": \"\",\n \"id\": \"\"\n },\n {\n \"deleted\": \"\",\n \"id\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "delete-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-address-alteration-set", "item": [ { "name": "Address Alteration Get Address Alteration Set", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] }, "description": " This API endpoint can be used to find an existing Address Alteration Set. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-address-alteration-set", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-address-alteration-set" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"depth\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-definition", "item": [ { "name": "Address Alteration Get Definition", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] }, "description": " This API endpoint can be used to find an existing Address Alteration Definition. Each request field is optional, however at least one must be specified in the request body. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"items\": [\n {\n \"addressType\": \"\",\n \"id\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"\"\n },\n {\n \"addressType\": \"\",\n \"id\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"\"\n }\n ]\n },\n {\n \"items\": [\n {\n \"addressType\": \"\",\n \"id\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"\"\n },\n {\n \"addressType\": \"\",\n \"id\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"all\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-definition", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-definition" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"inbound\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"folderId\": \"\",\n \"newAddress\": \"\",\n \"originalAddress\": \"\",\n \"routing\": \"outbound\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-policy", "item": [ { "name": "Address Alteration Get Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] }, "description": " This API endpoint can be used to find an existing Address Alteration policy. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"id\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"addressAlterationSetId\": \"\",\n \"id\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "get-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "update-policy", "item": [ { "name": "Address Alteration Update Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] }, "description": " This API endpoint can be used to update an existing Address Alteration policy. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"addressAlterationSetId\": \"\",\n \"id\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"addressAlterationSetId\": \"\",\n \"id\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"free_mail_domains\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/address-alteration/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "address-alteration", "update-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"addressAlterationSetId\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "antispoofing-bypass", "item": [ { "name": "create-policy", "item": [ { "name": "Antispoofing Bypass Create Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] }, "description": " This endpoint can be used to create a new Anti-Spoofing SPF based Bypass policy. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"web_device\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "create-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" } ] } ] }, { "name": "delete-policy", "item": [ { "name": "Antispoofing Bypass Delete Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] }, "description": " This endpoint can be used to find existing Anti-Spoofing SPF based Bypass policies. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"deleted\": \"\",\n \"id\": \"\"\n },\n {\n \"deleted\": \"\",\n \"id\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/delete-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "delete-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-policy", "item": [ { "name": "Antispoofing Bypass Get Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] }, "description": " This endpoint can be used to find existing Anti-Spoofing SPF based Bypass policies. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"free_mail_domains\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"free_mail_domains\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "get-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "update-policy", "item": [ { "name": "Antispoofing Bypass Update Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] }, "description": " This endpoint can be used to update an existing Anti-Spoofing SPF based Bypass policy. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"free_mail_domains\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"enable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"any_shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/antispoofing-bypass/update-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "antispoofing-bypass", "update-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"shared_drive\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"option\": \"disable_bypass\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "blockedsenders", "item": [ { "name": "create-policy", "item": [ { "name": "Blockedsenders Create Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] }, "description": " This endpoint creates new blocked sender policies, which can be used to manage a combination of sender and recipient restrictions. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"device\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"deviceGroup\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"device\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"deviceGroup\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"device\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"deviceGroup\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"device\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"deviceGroup\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/create-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "create-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"block_sender\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"option\": \"no_action\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"sourceIPs\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"headerDisplayName\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n }\n ]\n}" } ] } ] }, { "name": "get-policy", "item": [ { "name": "Blockedsenders Get Policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] }, "description": " This endpoint retrieves blocked sender policies. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Gateway | Policies | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"deviceGroup\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"headerDisplayName\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"device\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"headerDisplayName\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"option\": \"\",\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"deviceGroup\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"headerDisplayName\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"device\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"headerDisplayName\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/blockedsenders/get-policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "blockedsenders", "get-policy" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "webwhiteurl", "item": [ { "name": "create-policy-with-targets", "item": [ { "name": "Webwhiteurl Create Policy With Targets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] }, "description": " This endpoint can be used to create a Web Security Block or Allow List policy for domains or URLs. The Block or Allow List API endpoint enforces the existing 5,000 limit for total URLs supported in a policy and 25,000 limit for a customer account. This API is intended to automate low volume, day-to-day transactions and is not intended for use of bulk imports or large initial imports of domains or URLs. For more information about Web Security Policies, visit Mimecaster Central . Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Web Security | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"policies\": [\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"policies\": [\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/create-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "create-policy-with-targets" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"cloud_service_connector\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"email_domain\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" } ] } ] }, { "name": "delete-policy-with-targets", "item": [ { "name": "Webwhiteurl Delete Policy With Targets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] }, "description": " This endpoint can be used to delete an existing Web Security Block or Allow List policy for domains or URLs. The Block or Allow List API endpoint enforces the existing 5,000 limit for total URLs supported in a policy and 25,000 limit for a customer account. This API is intended to automate low volume, day-to-day transactions and is not intended for use of bulk imports or large initial imports of domains or URLs. For more information about Web Security Policies, visit Mimecaster Central . Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Web Security | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"deleted\": \"\",\n \"id\": \"\"\n },\n {\n \"deleted\": \"\",\n \"id\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/delete-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "delete-policy-with-targets" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-policy-with-targets", "item": [ { "name": "Webwhiteurl Get Policy With Targets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] }, "description": " This endpoint can be used to get information about an existing Web Security Block or Allow List policy for domains or URLs. The Block or Allow List API endpoint enforces the existing 5,000 limit for total URLs supported in a policy and 25,000 limit for a customer account. This API is intended to automate low volume, day-to-day transactions and is not intended for use of bulk imports or large initial imports of domains or URLs. For more information about Web Security Policies, visit Mimecaster Central . Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Web Security | Policies | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"policies\": [\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {},\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {},\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {},\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"free_mail_domains\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {},\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"everyone\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"policies\": [\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {},\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"external_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {},\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {},\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {},\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {},\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/get-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "get-policy-with-targets" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "update-policy-with-targets", "item": [ { "name": "Webwhiteurl Update Policy With Targets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] }, "description": " This endpoint can be used to update an existing Web Security Block or Allow List policy for domains or URLs. The Block or Allow List API endpoint enforces the existing 5,000 limit for total URLs supported in a policy and 25,000 limit for a customer account. This API is intended to automate low volume, day-to-day transactions and is not intended for use of bulk imports or large initial imports of domains or URLs. For more information about Web Security Policies, visit Mimecaster Central . Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Web Security | Policies | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"policies\": [\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"internal_addresses\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"policies\": [\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"web_device_group\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"locations\": [\n {\n \"ip\": \"\",\n \"location\": \"\"\n },\n {\n \"ip\": \"\",\n \"location\": \"\"\n }\n ],\n \"policy\": {\n \"bidirectional\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"createTime\": \"\",\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"email_domain\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"\",\n \"fromType\": \"\",\n \"fromValue\": \"\",\n \"lastUpdated\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"group\": {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"folders\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n \"type\": \"internal_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\",\n \"toType\": \"\",\n \"toValue\": \"\"\n }\n }\n ],\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"external_addresses\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"everyone\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"envelope_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"free_mail_domains\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"header_display_name\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"block\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/policy/webwhiteurl/update-policy-with-targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "policy", "webwhiteurl", "update-policy-with-targets" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"address_attribute_value\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"profile_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"both\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\",\n \"policies\": [\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"individual_email_address\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n },\n {\n \"bidirectional\": \"\",\n \"comment\": \"\",\n \"conditions\": {\n \"hostnames\": [\n \"\",\n \"\"\n ],\n \"sourceIPs\": [\n \"\",\n \"\"\n ],\n \"spfDomains\": [\n \"\",\n \"\"\n ]\n },\n \"description\": \"\",\n \"enabled\": \"\",\n \"enforced\": \"\",\n \"from\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device_group\"\n },\n \"fromDate\": \"\",\n \"fromEternal\": \"\",\n \"fromPart\": \"header_from\",\n \"id\": \"\",\n \"override\": \"\",\n \"to\": {\n \"attribute\": {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\"\n },\n \"emailAddress\": \"\",\n \"emailDomain\": \"\",\n \"groupId\": \"\",\n \"type\": \"web_device\"\n },\n \"toDate\": \"\",\n \"toEternal\": \"\"\n }\n ],\n \"description\": \"\",\n \"urls\": [\n {\n \"action\": \"block\",\n \"type\": \"domain\",\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"action\": \"allow\",\n \"type\": \"url\",\n \"value\": \"\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "dlp", "item": [ { "name": "get-logs", "item": [ { "name": "Dlp Get Logs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] }, "description": " This endpoint can be used to retrieve messages that triggered a DLP or Content Examination policy. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Monitoring | Data Leak Prevention | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"dlpLogs\": [\n {\n \"action\": \"\",\n \"eventTime\": \"\",\n \"messageId\": \"\",\n \"policy\": \"\",\n \"recipientAddress\": \"\",\n \"route\": \"\",\n \"senderAddress\": \"\",\n \"subject\": \"\"\n },\n {\n \"action\": \"\",\n \"eventTime\": \"\",\n \"messageId\": \"\",\n \"policy\": \"\",\n \"recipientAddress\": \"\",\n \"route\": \"\",\n \"senderAddress\": \"\",\n \"subject\": \"\"\n }\n ]\n },\n {\n \"dlpLogs\": [\n {\n \"action\": \"\",\n \"eventTime\": \"\",\n \"messageId\": \"\",\n \"policy\": \"\",\n \"recipientAddress\": \"\",\n \"route\": \"\",\n \"senderAddress\": \"\",\n \"subject\": \"\"\n },\n {\n \"action\": \"\",\n \"eventTime\": \"\",\n \"messageId\": \"\",\n \"policy\": \"\",\n \"recipientAddress\": \"\",\n \"route\": \"\",\n \"senderAddress\": \"\",\n \"subject\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"disable_stationery\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"bounce\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"subject\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"link\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"outbound\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"link\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"outbound\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"link\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"outbound\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"link\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"outbound\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"link\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"outbound\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"link\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"outbound\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"inbound\",\n \"searchField\": \"policy\",\n \"to\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/dlp/get-logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "dlp", "get-logs" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"disable_document_policy\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"internal\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"actions\": \"link\",\n \"from\": \"\",\n \"oldestFirst\": \"\",\n \"query\": \"\",\n \"routes\": \"outbound\",\n \"searchField\": \"recipientAddress\",\n \"to\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "byo-threat-intelligence", "item": [ { "name": "create-batch", "item": [ { "name": "Byo Threat Intelligence Create Batch", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] }, "description": " This endpoint can be used to import a single or batch of multiple indicators. These indicators can be used to perform a specific action based on their presence. For example, a file-hash can be added with a block action to prevent the delivery of a message with an attachment matching that file-hash.Currently, only file-hashes are supported. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted BYO Threat Intelligence | Upload . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"batchIdToken\": \"\",\n \"completionTime\": \"\",\n \"createTime\": \"\",\n \"hashCount\": \"\",\n \"operationType\": \"BLOCK\",\n \"status\": \"PARTIALLY_COMPLETED\"\n },\n {\n \"batchIdToken\": \"\",\n \"completionTime\": \"\",\n \"createTime\": \"\",\n \"hashCount\": \"\",\n \"operationType\": \"ALLOW\",\n \"status\": \"IN_PROGRESS\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"BLOCK\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"ALLOW\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"ALLOW\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"ALLOW\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"ALLOW\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"ALLOW\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"ALLOW\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/create-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "create-batch" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"ALLOW\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"hashList\": [\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n },\n {\n \"hash\": \"\",\n \"description\": \"\",\n \"provider\": \"\"\n }\n ],\n \"operationType\": \"DELETE\"\n }\n }\n ]\n}" } ] } ] }, { "name": "delete-batch", "item": [ { "name": "Byo Threat Intelligence Delete Batch", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] }, "description": " This endpoint can be used to remove a batch of indicators. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted BYO Threat Intelligence | Delete . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"success\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/delete-batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "delete-batch" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-batches", "item": [ { "name": "Byo Threat Intelligence Get Batches", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] }, "description": " This endpoint can be used to retrieve information about all existing batches. In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted BYO Threat Intelligence | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"batchIdToken\": \"\",\n \"completionTime\": \"\",\n \"createTime\": \"\",\n \"hashCount\": \"\",\n \"operationType\": \"BLOCK\",\n \"status\": \"PARTIALLY_COMPLETED\"\n },\n {\n \"batchIdToken\": \"\",\n \"completionTime\": \"\",\n \"createTime\": \"\",\n \"hashCount\": \"\",\n \"operationType\": \"ALLOW\",\n \"status\": \"IN_PROGRESS\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"asc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"asc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"asc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"asc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"asc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"asc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"asc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-batches" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"desc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"order\": \"asc\",\n \"sortBy\": \"CREATE_TIME\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-quota", "item": [ { "name": "Byo Threat Intelligence Get Quota", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] }, "description": " This endpoint can be used to retrieve the number of indicators in use and the number of remaining indicators that can be added. Pre-requisites In order to successfully use this endpoint the account must have the Bring Your Own Threat Intel package added. For more information about getting access to Bring Your Own Threat Intel, you can reach out to your Mimecast Account Manager. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"availableQuota\": \"\",\n \"consumedQuota\": \"\"\n },\n {\n \"availableQuota\": \"\",\n \"consumedQuota\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/byo-threat-intelligence/get-quota", "host": [ "{{baseUrl}}" ], "path": [ "api", "byo-threat-intelligence", "get-quota" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] } ] }, { "name": "directory", "item": [ { "name": "add-group-member", "item": [ { "name": "Directory Add Group Member", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] }, "description": " This endpoint can be used to add user email addresses or domains to a profile group. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Groups | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"folderId\": \"\",\n \"id\": \"\",\n \"internal\": \"\",\n \"notes\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"folderId\": \"\",\n \"id\": \"\",\n \"internal\": \"\",\n \"notes\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"notes\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/add-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "add-group-member" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"notes\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "create-group", "item": [ { "name": "Directory Create Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] }, "description": " This API endpoint can be used to create new Profile Groups at the root level, or as a child-group. Groups can be used to apply permissions and policies. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Groups | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/create-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "create-group" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "delete-group", "item": [ { "name": "Directory Delete Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] }, "description": " This endpoint can be used to delete an exiting profile group. Note: The Profile group must be empty of members or child-groups prior to deletion. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Groups | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"status\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/delete-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "delete-group" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "execute-sync", "item": [ { "name": "Directory Execute Sync", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] }, "description": " This endpoint can be used to initiate directory synchronization. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Directory Sync | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"syncStatus\": \"\",\n \"type\": \"\"\n },\n {\n \"syncStatus\": \"\",\n \"type\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/execute-sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "execute-sync" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] }, { "name": "find-groups", "item": [ { "name": "Directory Find Groups", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] }, "description": " This endpoint can be used to find groups that exist on a tenant. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Groups | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\"\n }\n ],\n \"query\": \"\",\n \"source\": \"\"\n },\n {\n \"folders\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\"\n }\n ],\n \"query\": \"\",\n \"source\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"ldap\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"ldap\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"ldap\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"ldap\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"ldap\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"ldap\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"ldap\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/find-groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "find-groups" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"cloud\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"query\": \"\",\n \"source\": \"ldap\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-connection", "item": [ { "name": "Directory Get Connection", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] }, "description": " This endpoint can be used to retrieve directory connectors that are configured on the tenant. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Directory Sync | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"acknowledgeDisabledAccounts\": \"\",\n \"adPushSettings\": {\n \"hostname\": \"\",\n \"rootDn\": \"\",\n \"userDn\": \"\"\n },\n \"description\": \"\",\n \"domains\": \"\",\n \"id\": \"\",\n \"lastSync\": \"\",\n \"ldapSettings\": {\n \"encryptionMode\": \"relaxed\",\n \"hostname\": \"\",\n \"port\": \"\",\n \"rootDn\": \"\",\n \"userDn\": \"\"\n },\n \"office365Settings\": {\n \"clientId\": \"\",\n \"tenantDomain\": \"\"\n },\n \"serverType\": \"\",\n \"status\": \"\",\n \"syncRunning\": \"\"\n },\n {\n \"acknowledgeDisabledAccounts\": \"\",\n \"adPushSettings\": {\n \"hostname\": \"\",\n \"rootDn\": \"\",\n \"userDn\": \"\"\n },\n \"description\": \"\",\n \"domains\": \"\",\n \"id\": \"\",\n \"lastSync\": \"\",\n \"ldapSettings\": {\n \"encryptionMode\": \"strict\",\n \"hostname\": \"\",\n \"port\": \"\",\n \"rootDn\": \"\",\n \"userDn\": \"\"\n },\n \"office365Settings\": {\n \"clientId\": \"\",\n \"tenantDomain\": \"\"\n },\n \"serverType\": \"\",\n \"status\": \"\",\n \"syncRunning\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/directory/get-connection", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-connection" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-group-members", "item": [ { "name": "Directory Get Group Members", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] }, "description": " This endpoint can be used to retrieve group members from groups the exist on a tenant. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Directory Sync | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"groupMembers\": [\n {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"internal\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"notes\": \"\"\n },\n {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"internal\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"notes\": \"\"\n }\n ]\n },\n {\n \"groupMembers\": [\n {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"internal\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"notes\": \"\"\n },\n {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"internal\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"notes\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/get-group-members", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "get-group-members" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "remove-group-member", "item": [ { "name": "Directory Remove Group Member", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] }, "description": " This endpoint can be used to remove group members from Mimecast Profile groups. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Directory Sync | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"folderId\": \"\",\n \"id\": \"\",\n \"internal\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"folderId\": \"\",\n \"id\": \"\",\n \"internal\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/remove-group-member", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "remove-group-member" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "update-group", "item": [ { "name": "Directory Update Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] }, "description": " The update group endpoint can be used to update the description of Mimecast Profile groups. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Services | Directory Sync | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n },\n {\n \"description\": \"\",\n \"folderCount\": \"\",\n \"id\": \"\",\n \"parentId\": \"\",\n \"source\": \"\",\n \"userCount\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"parentId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/directory/update-group", "host": [ "{{baseUrl}}" ], "path": [ "api", "directory", "update-group" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"description\": \"\",\n \"id\": \"\",\n \"parentId\": \"\"\n }\n }\n ]\n}" } ] } ] } ] }, { "name": "user", "item": [ { "name": "add-delegate-user", "item": [ { "name": "User Add Delegate User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] }, "description": " This API endpoint provides the ability to create a new delegate permission for a user based on their primary address. More information about delegates is available in Mimecaster Central . Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Create Alternate Address . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"success\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-delegate-user" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"delegateAddress\": \"\",\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "add-to-purge-list", "item": [ { "name": "User Add To Purge List", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] }, "description": " This endpoint can be used to add internal or external users to the Purge List. The Purge List gets examined each evening as part of the nightly housekeeping tasks. If there are not any active items present for the address, it will be fully removed from the account. Pre-requisites In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Directories | Internal | Purge Address permission. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"rejectedAddresses\": [\n {\n \"emailAddress\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ]\n },\n {\n \"emailAddress\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"rejectedAddresses\": [\n {\n \"emailAddress\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ]\n },\n {\n \"emailAddress\": \"\",\n \"reasons\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/add-to-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "add-to-purge-list" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" } ] } ] }, { "name": "create-user", "item": [ { "name": "User Create User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] }, "description": " This endpoint can be used to create new cloud-users in Mimecast's Internal Directories. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"id\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"id\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountCode\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/create-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-user" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountCode\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "find-delegate-users", "item": [ { "name": "User Find Delegate Users", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] }, "description": " This API endpoint provides the ability to return delegate permissions for a user based on their primary address. More information about delegates is availabile in Mimecaster Central . Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Create Alternate Address . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"delegateUsers\": [\n {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"source\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"source\": \"\"\n }\n ]\n },\n {\n \"delegateUsers\": [\n {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"source\": \"\"\n },\n {\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"source\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"primaryAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/find-delegate-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "find-delegate-users" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"primaryAddress\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-aliases", "item": [ { "name": "User Get Aliases", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] }, "description": " The get aliases endpoint can be used to retrieve aliases associated with a primary email address. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Groups | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"aliases\": [\n {\n \"displayName\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"isInternal\": \"\",\n \"type\": \"\"\n },\n {\n \"displayName\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"isInternal\": \"\",\n \"type\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n },\n {\n \"aliases\": [\n {\n \"displayName\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"isInternal\": \"\",\n \"type\": \"\"\n },\n {\n \"displayName\": \"\",\n \"domain\": \"\",\n \"emailAddress\": \"\",\n \"isInternal\": \"\",\n \"type\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-aliases", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-aliases" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-attributes", "item": [ { "name": "User Get Attributes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] }, "description": " This endpoint can be used to retrieve attributes that are registered on the tenant, for a given user. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n },\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\"\n },\n {\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-attributes" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddress\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-import-status", "item": [ { "name": "User Get Import Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] }, "description": " This endpoint can the used to get the current status of a user import request, using /api/user/import-users. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Import | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"created\": \"\",\n \"id\": \"\",\n \"importer\": \"\",\n \"notifyEmailAddress\": \"\",\n \"reportFile\": \"\",\n \"sourceFile\": \"\",\n \"status\": \"\",\n \"successfulImportedUsers\": \"\",\n \"totalUsers\": \"\"\n },\n {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"created\": \"\",\n \"id\": \"\",\n \"importer\": \"\",\n \"notifyEmailAddress\": \"\",\n \"reportFile\": \"\",\n \"sourceFile\": \"\",\n \"status\": \"\",\n \"successfulImportedUsers\": \"\",\n \"totalUsers\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/user/get-import-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-import-status" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-internal-users", "item": [ { "name": "User Get Internal Users", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] }, "description": " This endpoint can be used to retrieve all internal users for a given domain. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Read . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"userCount\": \"\",\n \"users\": [\n {\n \"addressType\": \"\",\n \"alias\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"addressType\": \"\",\n \"alias\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n },\n {\n \"userCount\": \"\",\n \"users\": [\n {\n \"addressType\": \"\",\n \"alias\": \"\",\n \"emailAddress\": \"\"\n },\n {\n \"addressType\": \"\",\n \"alias\": \"\",\n \"emailAddress\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"domain\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/get-internal-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-internal-users" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"domain\": \"\",\n \"includeDl\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "get-most-used-contacts", "item": [ { "name": "User Get Most Used Contacts", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] }, "description": " This endpoint returns the most used contacts synced from Azure Active Directory. Pre-requisites No Mimecast Administrator Role required. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"contacts\": [\n {\n \"avatar\": \"\",\n \"avatarMimeType\": \"\",\n \"emailAddress\": \"\",\n \"name\": \"\"\n },\n {\n \"avatar\": \"\",\n \"avatarMimeType\": \"\",\n \"emailAddress\": \"\",\n \"name\": \"\"\n }\n ]\n },\n {\n \"contacts\": [\n {\n \"avatar\": \"\",\n \"avatarMimeType\": \"\",\n \"emailAddress\": \"\",\n \"name\": \"\"\n },\n {\n \"avatar\": \"\",\n \"avatarMimeType\": \"\",\n \"emailAddress\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/get-most-used-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "get-most-used-contacts" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {}\n }\n ]\n}" } ] } ] }, { "name": "import-users", "item": [ { "name": "User Import Users", "request": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "et consequat velit Ut", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"notifyEmailAddress\":\"String\", \"allowAddressMigration\":true, \"groupId\":\"String\", \"clearGroup\":false, \"fileType\":\"csv\" } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/user/import-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "import-users" ] }, "description": " The import users endpoint can be used to import users to an Internal Directory or a Profile Group. Users are imported via file upload, using an XSLX, XLS or CSV file (a CSV-structured request body can also be used to perform a 'fileless' user import). A list of available fields can be found in our Community KB . The import users endpoint also supports AAA accounts, to import users to specific mail-processing child accounts. Note: If using the CSV file format, ensure your body ends with a new line character, to indicate the end of the file. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Import | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "et consequat velit Ut", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"notifyEmailAddress\":\"String\", \"allowAddressMigration\":true, \"groupId\":\"String\", \"clearGroup\":false, \"fileType\":\"csv\" } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/user/import-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "import-users" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"success\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"XLS\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "et consequat velit Ut", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"notifyEmailAddress\":\"String\", \"allowAddressMigration\":true, \"groupId\":\"String\", \"clearGroup\":false, \"fileType\":\"csv\" } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/user/import-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "import-users" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "et consequat velit Ut", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"notifyEmailAddress\":\"String\", \"allowAddressMigration\":true, \"groupId\":\"String\", \"clearGroup\":false, \"fileType\":\"csv\" } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/user/import-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "import-users" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "et consequat velit Ut", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"notifyEmailAddress\":\"String\", \"allowAddressMigration\":true, \"groupId\":\"String\", \"clearGroup\":false, \"fileType\":\"csv\" } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/user/import-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "import-users" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "et consequat velit Ut", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"notifyEmailAddress\":\"String\", \"allowAddressMigration\":true, \"groupId\":\"String\", \"clearGroup\":false, \"fileType\":\"csv\" } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/user/import-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "import-users" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "et consequat velit Ut", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"notifyEmailAddress\":\"String\", \"allowAddressMigration\":true, \"groupId\":\"String\", \"clearGroup\":false, \"fileType\":\"csv\" } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/user/import-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "import-users" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "x-mc-arg", "value": "et consequat velit Ut", "description": "A Header containing a JSON object.
e.g.

{ \"data\": [ { \"notifyEmailAddress\":\"String\", \"allowAddressMigration\":true, \"groupId\":\"String\", \"clearGroup\":false, \"fileType\":\"csv\" } ] }

" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "file", "file": {} }, "url": { "raw": "{{baseUrl}}/api/user/import-users", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "import-users" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"allowAddressMigration\": \"\",\n \"clearGroup\": \"\",\n \"fileType\": \"CSV\",\n \"groupId\": \"\",\n \"notifyEmailAddress\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "remove-alias", "item": [ { "name": "User Remove Alias", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] }, "description": " The remove alias endpoint can be used to remove a alias that has been associated with a primary email address. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Groups | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasDisplayName\": \"\",\n \"domain\": \"\",\n \"isInternal\": \"\",\n \"type\": \"\"\n },\n {\n \"alias\": \"\",\n \"aliasDisplayName\": \"\",\n \"domain\": \"\",\n \"isInternal\": \"\",\n \"type\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-alias" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "remove-delegate-user", "item": [ { "name": "User Remove Delegate User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] }, "description": " This API endpoint provides the ability to remove delegate permissions for a user based on their primary address. More information about delegates is availabile in Mimecaster Central . Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Create Alternate Address . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"success\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-delegate-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-delegate-user" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"id\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "remove-from-purge-list", "item": [ { "name": "User Remove From Purge List", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] }, "description": " This endpoint can be used to remove internal or external users from the Purge List in case you added them by accident. Pre-requisites In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Directories | Internal | Remove Address from Purge List permission. " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"rejectedAddresses\": [\n \"\",\n \"\"\n ]\n },\n {\n \"rejectedAddresses\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/remove-from-purge-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "remove-from-purge-list" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"emailAddresses\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}" } ] } ] }, { "name": "update-alias", "item": [ { "name": "User Update Alias", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] }, "description": " This API endpoint can be used to modify secondary email addresses for users. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Groups | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasDisplayName\": \"\",\n \"aliasFor\": \"\",\n \"domain\": \"\",\n \"isInternal\": \"\",\n \"type\": \"\"\n },\n {\n \"alias\": \"\",\n \"aliasDisplayName\": \"\",\n \"aliasFor\": \"\",\n \"domain\": \"\",\n \"isInternal\": \"\",\n \"type\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-alias", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-alias" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"alias\": \"\",\n \"aliasFor\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "update-attributes", "item": [ { "name": "User Update Attributes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] }, "description": " This API endpoint can be used to update a non-directory synced user's attributes. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n },\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-attributes" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"attributes\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"emailAddress\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "update-user", "item": [ { "name": "User Update User", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] }, "description": " The update user endpoint can be used to update users within an Internal Directory. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Directories | Internal | Edit . " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"passwordNeverExpires\": \"\"\n },\n {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"emailAddress\": \"\",\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/update-user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "update-user" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"accountDisabled\": \"\",\n \"accountLocked\": \"\",\n \"allowPop\": \"\",\n \"allowSmtp\": \"\",\n \"archiveStartDate\": \"\",\n \"emailAddress\": \"\",\n \"forcePasswordChange\": \"\",\n \"name\": \"\",\n \"password\": \"\",\n \"passwordNeverExpires\": \"\"\n }\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "config-snapshot", "item": [ { "name": "v1", "item": [ { "name": "create", "item": [ { "name": "V1 Create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"managedsenders\",\n \"name\": \"Test backup 2025-01-24\",\n \"comment\": \"export for automation\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] }, "description": " Create a backup snapshot of the customers Mimecast configurations for: Managed Senders, Managed URLs and Profile Groups. Pre-requisites To successfully use this endpoint, the role assigned to the app must have at least the following level of application permissions granted: Account Menu | Config Snapshot | Backup . For additional information on usage and FAQ, see the Configuration Backup, Restore and Export APIs " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/create", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "create" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "export", "item": [ { "name": "V1 Export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"08fc6b2f-33ef-3973-8303-521067e68179\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] }, "description": " Export a backup snapshot of the customers Mimecast configurations for: Managed Senders, Managed URLs and Profile Groups. Pre-requisites To successfully use this endpoint, the role assigned to the app must have at least the following level of application permissions granted: Account Menu | Config Snapshot | Export. . For additional information on usage and FAQ, see the Configuration Backup, Restore and Export APIs " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"downloadUrl\": \"\"\n },\n {\n \"downloadUrl\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"exportSource\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/export", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "export" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"exportSource\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "list", "item": [ { "name": "V1 List", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"managedsenders\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] }, "description": " Get the comprehensive list of configuration snapshots for the customers Mimecast settings, including those for: Managed Senders, Managed URLs and Profile Groups Pre-requisites To successfully use this endpoint, the role assigned to the app must have at least the following level of application permissions granted: Account Menu | Config Snapshot | List. . For additional information on usage and FAQ, see the Configuration Backup, Restore and Export APIs " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"snapshotMetadata\": [\n {\n \"accountCode\": \"\",\n \"comment\": \"\",\n \"createTime\": \"\",\n \"guid\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"userAddress\": \"\"\n },\n {\n \"accountCode\": \"\",\n \"comment\": \"\",\n \"createTime\": \"\",\n \"guid\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"userAddress\": \"\"\n }\n ]\n },\n {\n \"snapshotMetadata\": [\n {\n \"accountCode\": \"\",\n \"comment\": \"\",\n \"createTime\": \"\",\n \"guid\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"userAddress\": \"\"\n },\n {\n \"accountCode\": \"\",\n \"comment\": \"\",\n \"createTime\": \"\",\n \"guid\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"userAddress\": \"\"\n }\n ]\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/list", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "list" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\"\n }\n }\n ]\n}" } ] } ] }, { "name": "restore", "item": [ { "name": "V1 Restore", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] }, "description": " Restore a backup snapshot of the customers Mimecast configurations for: Managed Senders, Managed URLs and Profile Groups. The configurations can be restored in: Append Mode - restores deleted entries by addition to the current hierarchy i.e., new entries after the backup are not deleted. Overwrite Mode – restore deleted entries by replacing the current hierarchy i.e., new entries after the backup are deleted. Pre-requisites To successfully use this endpoint, the role assigned to the app must have at least the following level of application permissions granted: Account Menu | Config Snapshot | Export. . For additional information on usage and FAQ, see the Configuration Backup, Restore and Export APIs " }, "response": [ { "name": "The request was processed and executed. This does not mean that the requested action was successful. Function-level success or failure is indicated in the response body content.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n ]\n}" }, { "name": "The request cannot be processed because it is either malformed or not correct.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n ]\n}" }, { "name": "The requested resource does not exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n ]\n}" }, { "name": "The current status of the relying data does not match what is defined in the request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/config-snapshot/v1/restore", "host": [ "{{baseUrl}}" ], "path": [ "config-snapshot", "v1", "restore" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"key\": {\n \"backupType\": \"\",\n \"mode\": \"\",\n \"restoreSource\": \"\",\n \"scope\": {\n \"unit\": \"\",\n \"value\": [\n \"\",\n \"\"\n ]\n }\n }\n }\n ]\n}" } ] } ] } ] } ] }, { "name": "account", "item": [ { "name": "cloud-gateway", "item": [ { "name": "v1", "item": [ { "name": "emergency-contact", "item": [ { "name": "Get V1 Emergency Contact", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/cloud-gateway/v1/emergency-contact", "host": [ "{{baseUrl}}" ], "path": [ "account", "cloud-gateway", "v1", "emergency-contact" ] }, "description": " Returns the Emergency Contact information for the account. Pre-requisites In order to successfully use this endpoint the role assigned to the app must have at least the following level of application permissions granted Account | Settings | Read . " }, "response": [ { "name": "Emergency contact for account", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/cloud-gateway/v1/emergency-contact", "host": [ "{{baseUrl}}" ], "path": [ "account", "cloud-gateway", "v1", "emergency-contact" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"contactName\": \"\",\n \"contactEmailAddress\": \"\",\n \"mobilePhone\": \"\",\n \"telephone\": \"\",\n \"alternateEmailAddresses\": [\n \"\",\n \"\"\n ]\n}" }, { "name": "Authorization information is either missing, incomplete or incorrect.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/cloud-gateway/v1/emergency-contact", "host": [ "{{baseUrl}}" ], "path": [ "account", "cloud-gateway", "v1", "emergency-contact" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"field\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"field\": \"\"\n }\n ]\n}" }, { "name": "Access is denied to the requested resource. The user may not have enough permission to perform the action.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/cloud-gateway/v1/emergency-contact", "host": [ "{{baseUrl}}" ], "path": [ "account", "cloud-gateway", "v1", "emergency-contact" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"field\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"field\": \"\"\n }\n ]\n}" }, { "name": "Quota Exceeded\tThe number of requests sent to the given resource has exceeded the rate limiting policy applied to the resource for a given time period. Rate limiting is applied differently per resource and is subject to change.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/cloud-gateway/v1/emergency-contact", "host": [ "{{baseUrl}}" ], "path": [ "account", "cloud-gateway", "v1", "emergency-contact" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"fail\": [\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n },\n {\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"retryable\": \"\"\n }\n ]\n }\n ]\n}" }, { "name": "The request was not processed successfully or an issue has occurred in the Mimecast platform.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account/cloud-gateway/v1/emergency-contact", "host": [ "{{baseUrl}}" ], "path": [ "account", "cloud-gateway", "v1", "emergency-contact" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "x-request-id", "value": "", "description": { "content": "The unique identifier for this API call", "type": "text/plain" } }, { "key": "date", "value": "", "description": { "content": "Timestamp of the API call", "type": "text/plain" } } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"field\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"field\": \"\"\n }\n ]\n}" } ] }, { "name": "

Description

Creates an Emergency Contact for the account.

Pre-requisites