api-reference.json

{
  "metadata": {
    "source": "https://developer.services.mimecast.com/apis",
    "scraped_at": "2025-12-12T14:52:57.838923Z",
    "total_endpoints": 257,
    "categories": [
      "Archivedataaccess",
      "Audit Events",
      "Account Management",
      "Policy Management",
      "Threatssecurity Eventsanddataforcg",
      "Threat Management",
      "Domain Management",
      "Emailsecurityonboarding",
      "Connector",
      "Cloud Gateway",
      "Userandgroup Management",
      "Awareness Training"
    ]
  },
  "endpoints": [
    {
      "id": "emergency-contact",
      "name": "Emergency Contact",
      "category": "Account Management",
      "method": "GET",
      "path": "/account/cloud-gateway/v1/emergency-contact",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/account/cloud-gateway/v1/emergency-contact/get",
      "last_updated": "2025-12-12T14:43:05.688832+00:00"
    },
    {
      "id": "emergency-contact",
      "name": "Emergency Contact",
      "category": "Account Management",
      "method": "PUT",
      "path": "/account/cloud-gateway/v1/emergency-contact",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/account/cloud-gateway/v1/emergency-contact/put",
      "last_updated": "2025-12-12T14:43:06.962623+00:00"
    },
    {
      "id": "emergency-contact",
      "name": "Emergency Contact",
      "category": "Account Management",
      "method": "PATCH",
      "path": "/account/cloud-gateway/v1/emergency-contact",
      "description": "Description Updates the Emergency Contact information for the account. Updates the Emergency Contact information for the account.",
      "parameters": [
        {
          "name": "contactName",
          "description": "string Name of the emergency contact. length  \u2264 60"
        },
        {
          "name": "contactEmailAddress",
          "description": "string Email address of the emergency contact."
        },
        {
          "name": "mobilePhone",
          "description": "string Mobile number of emergency contact in international format (with +). Please see Country Calling Codes ."
        },
        {
          "name": "telephone",
          "description": "string Telephone of emergency contact in international format (with +). Please see Country Calling Codes ."
        },
        {
          "name": "alternateEmailAddresses",
          "description": "array Alternate Email address for the emergency contact must contain at most 4 items"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/account/cloud-gateway/v1/emergency-contact/patch",
      "last_updated": "2025-12-12T14:43:08.235282+00:00"
    },
    {
      "id": "get-account",
      "name": "Get Account",
      "category": "Account Management",
      "method": "POST",
      "path": "/api/account/get-account",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/api/account/get-account/post",
      "last_updated": "2025-12-12T14:43:09.514953+00:00"
    },
    {
      "id": "get-dashboard-notifications",
      "name": "Get Dashboard Notifications",
      "category": "Account Management",
      "method": "POST",
      "path": "/api/account/get-dashboard-notifications",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/api/account/get-dashboard-notifications/post",
      "last_updated": "2025-12-12T14:43:10.779132+00:00"
    },
    {
      "id": "get-support-info",
      "name": "Get Support Info",
      "category": "Account Management",
      "method": "POST",
      "path": "/api/account/get-support-info",
      "description": "Description This endpoint returns support information that is associated with a Mimecast tenant. This endpoint returns support information that is associated with a Mimecast tenant.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less customerAdvocate string The name of the Mimecast Customer Advocate aligned to the customer account. customerDevelopmentManager string The name of the Customer Development Manager aligned to the customer account. hostingJurisdiction string The region that the customer account is hosted in. mailtoLink string A link to email Mimecast support. mainProduct string The main product that the customers has subscribed to. officePhone string The office phone number for the region that rovides support for the customer account. partnerName string The name of the partner aligned to the customer account if applicable. renewalDate string The customer's contract renewal date. supportJurisdiction string The region that provides support for the customer account. supportPackage string The support package that the customer has subscribed to.",
          "description": "customerAdvocate string The name of the Mimecast Customer Advocate aligned to the customer account. customerDevelopmentManager string The name of the Customer Development Manager aligned to the customer account. hostingJurisdiction string The region that the customer account is hosted in. mailtoLink string A link to email Mimecast support. mainProduct string The main product that the customers has subscribed to. officePhone string The office phone number for the region that rovides support for the customer account. partnerName string The name of the partner aligned to the customer account if applicable. renewalDate string The customer's contract renewal date. supportJurisdiction string The region that provides support for the customer account. supportPackage string The support package that the customer has subscribed to."
        },
        {
          "name": "customerAdvocate",
          "description": "string The name of the Mimecast Customer Advocate aligned to the customer account."
        },
        {
          "name": "customerDevelopmentManager",
          "description": "string The name of the Customer Development Manager aligned to the customer account."
        },
        {
          "name": "hostingJurisdiction",
          "description": "string The region that the customer account is hosted in."
        },
        {
          "name": "mailtoLink",
          "description": "string A link to email Mimecast support."
        },
        {
          "name": "mainProduct",
          "description": "string The main product that the customers has subscribed to."
        },
        {
          "name": "officePhone",
          "description": "string The office phone number for the region that rovides support for the customer account."
        },
        {
          "name": "partnerName",
          "description": "string The name of the partner aligned to the customer account if applicable."
        },
        {
          "name": "renewalDate",
          "description": "string The customer's contract renewal date."
        },
        {
          "name": "supportJurisdiction",
          "description": "string The region that provides support for the customer account."
        },
        {
          "name": "supportPackage",
          "description": "string The support package that the customer has subscribed to."
        },
        {
          "name": "fail",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less errors array expand_less object expand_more key object The request item associated with this error",
          "description": "errors array expand_less object expand_more key object The request item associated with this error"
        },
        {
          "name": "errors",
          "description": "array expand_less"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "key",
          "description": "object The request item associated with this error"
        },
        {
          "name": "customerAdvocate",
          "description": "string The name of the Mimecast Customer Advocate aligned to the customer account."
        },
        {
          "name": "customerDevelopmentManager",
          "description": "string The name of the Customer Development Manager aligned to the customer account."
        },
        {
          "name": "hostingJurisdiction",
          "description": "string The region that the customer account is hosted in."
        },
        {
          "name": "mailtoLink",
          "description": "string A link to email Mimecast support."
        },
        {
          "name": "mainProduct",
          "description": "string The main product that the customers has subscribed to."
        },
        {
          "name": "officePhone",
          "description": "string The office phone number for the region that rovides support for the customer account."
        },
        {
          "name": "partnerName",
          "description": "string The name of the partner aligned to the customer account if applicable."
        },
        {
          "name": "renewalDate",
          "description": "string The customer's contract renewal date."
        },
        {
          "name": "supportJurisdiction",
          "description": "string The region that provides support for the customer account."
        },
        {
          "name": "supportPackage",
          "description": "string The support package that the customer has subscribed to."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/api/account/get-support-info/post",
      "last_updated": "2025-12-12T14:43:12.137540+00:00"
    },
    {
      "id": "provisioning-get-packages",
      "name": "Provisioning/Get Packages",
      "category": "Account Management",
      "method": "POST",
      "path": "/api/provisioning/get-packages",
      "description": "Description This endpoint returns products that are available to be provisioned by a partner. This endpoint returns products that are available to be provisioned by a partner.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less products object expand_less An object containing the product ID and name values. id string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts. name string The name of the product.",
          "description": "products object expand_less An object containing the product ID and name values. id string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts. name string The name of the product. id string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts. name string The name of the product."
        },
        {
          "name": "products",
          "description": "object expand_less An object containing the product ID and name values."
        },
        {
          "name": "id string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts. name string The name of the product.",
          "description": "id string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts. name string The name of the product."
        },
        {
          "name": "id",
          "description": "string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts."
        },
        {
          "name": "name",
          "description": "string The name of the product."
        },
        {
          "name": "fail",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less errors array expand_less object expand_more key object The request item associated with this error",
          "description": "errors array expand_less object expand_more key object The request item associated with this error"
        },
        {
          "name": "errors",
          "description": "array expand_less"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "key",
          "description": "object The request item associated with this error"
        },
        {
          "name": "products",
          "description": "object expand_less An object containing the product ID and name values."
        },
        {
          "name": "id string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts. name string The name of the product.",
          "description": "id string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts. name string The name of the product."
        },
        {
          "name": "id",
          "description": "string The ID of the product. This is the value that should be used in the \"product\" array when creating and updating accounts."
        },
        {
          "name": "name",
          "description": "string The name of the product."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/api/provisioning/get-packages/post",
      "last_updated": "2025-12-12T14:43:13.455225+00:00"
    },
    {
      "id": "create",
      "name": "Create",
      "category": "Account Management",
      "method": "POST",
      "path": "/config-snapshot/v1/create",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/config-snapshot/v1/create/post",
      "last_updated": "2025-12-12T14:43:14.725125+00:00"
    },
    {
      "id": "export",
      "name": "Export",
      "category": "Account Management",
      "method": "POST",
      "path": "/config-snapshot/v1/export",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/config-snapshot/v1/export/post",
      "last_updated": "2025-12-12T14:43:16.045505+00:00"
    },
    {
      "id": "list",
      "name": "List",
      "category": "Account Management",
      "method": "POST",
      "path": "/config-snapshot/v1/list",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/config-snapshot/v1/list/post",
      "last_updated": "2025-12-12T14:43:17.302369+00:00"
    },
    {
      "id": "restore",
      "name": "Restore",
      "category": "Account Management",
      "method": "POST",
      "path": "/config-snapshot/v1/restore",
      "description": "Description Restore a backup snapshot of the customers Mimecast configurations for: Managed Senders, Managed URLs and Profile Groups. The configurations can be restored in: 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. Append Mode - restores deleted entries by addition to the current hierarchy i.e., new entries after the backup are not deleted. Append Mode Append Mode - restores deleted entries by addition to the current hierarchy i.e., new entries after the backup are not deleted. Overwrite Mode \u2013 restore deleted entries by replacing the current hierarchy i.e., new entries after the backup are deleted. Overwrite Mode \u2013 restore deleted entries by replacing the current hierarchy i.e., new entries after the backup are deleted. Overwrite Mode Overwrite Mode \u2013 restore deleted entries by replacing the current hierarchy i.e., new entries after the backup are deleted.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less backupType (required) string Type of snapshot. The following values are supported: managedsenders, managedurls, profilegroups. mode (required) string Restore mode. The following values are supported: append, overwrite. restoreSource (required) string Restore snapshot from source GUID. scope (required) object expand_less Scope of the restore. unit (required) string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid value array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1.",
          "description": "backupType (required) string Type of snapshot. The following values are supported: managedsenders, managedurls, profilegroups. mode (required) string Restore mode. The following values are supported: append, overwrite. restoreSource (required) string Restore snapshot from source GUID. scope (required) object expand_less Scope of the restore. unit (required) string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid value array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1. unit (required) string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid value array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1."
        },
        {
          "name": "backupType (required)",
          "description": "string Type of snapshot. The following values are supported: managedsenders, managedurls, profilegroups."
        },
        {
          "name": "mode (required)",
          "description": "string Restore mode. The following values are supported: append, overwrite."
        },
        {
          "name": "restoreSource (required)",
          "description": "string Restore snapshot from source GUID."
        },
        {
          "name": "scope (required)",
          "description": "object expand_less Scope of the restore."
        },
        {
          "name": "unit (required) string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid value array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1.",
          "description": "unit (required) string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid value array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1."
        },
        {
          "name": "unit (required)",
          "description": "string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid"
        },
        {
          "name": "value",
          "description": "array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1."
        },
        {
          "name": "backupType (required)",
          "description": "string Type of snapshot. The following values are supported: managedsenders, managedurls, profilegroups."
        },
        {
          "name": "mode (required)",
          "description": "string Restore mode. The following values are supported: append, overwrite."
        },
        {
          "name": "restoreSource (required)",
          "description": "string Restore snapshot from source GUID."
        },
        {
          "name": "scope (required)",
          "description": "object expand_less Scope of the restore."
        },
        {
          "name": "unit (required) string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid value array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1.",
          "description": "unit (required) string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid value array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1."
        },
        {
          "name": "unit (required)",
          "description": "string Scoped restore unit. The following values are supported: for managedsenders backupType: all, recipient. for managedurls backupType: all, blocked, permitted. for profilegroups backupType: all, groupid"
        },
        {
          "name": "value",
          "description": "array Scoped restore values. The following values are supported: for managedsenders backupType: an array of recipient email addresses. for managedurls backupType: N/A. for profilegroups backypType: the id of the profile group the operation is scoped to, taken from the backup file - note this value must be provided as an array, but this must be of length 1."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/config-snapshot/v1/restore/post",
      "last_updated": "2025-12-12T14:43:18.609223+00:00"
    },
    {
      "id": "-identity-whoami",
      "name": "/Identity/Whoami",
      "category": "Account Management",
      "method": "GET",
      "path": "/identity/whoami",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/accountmanagement/1/routes/identity/whoami/get",
      "last_updated": "2025-12-12T14:43:19.869452+00:00"
    },
    {
      "id": "get-archive-search-logs",
      "name": "Get Archive Search Logs",
      "category": "Audit Events",
      "method": "POST",
      "path": "/api/archive/get-archive-search-logs",
      "description": "Description Retrieves archive search logs. Retrieves archive search logs.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain at most 1 item"
        },
        {
          "name": "object expand_less query string Text to search within the logs, which can contain email addresses.",
          "description": "query string Text to search within the logs, which can contain email addresses."
        },
        {
          "name": "query",
          "description": "string Text to search within the logs, which can contain email addresses."
        },
        {
          "name": "query",
          "description": "string Text to search within the logs, which can contain email addresses."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/auditevents/1/routes/api/archive/get-archive-search-logs/post",
      "last_updated": "2025-12-12T14:43:27.444967+00:00"
    },
    {
      "id": "get-search-logs",
      "name": "Get Search Logs",
      "category": "Audit Events",
      "method": "POST",
      "path": "/api/archive/get-search-logs",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/auditevents/1/routes/api/archive/get-search-logs/post",
      "last_updated": "2025-12-12T14:43:28.770519+00:00"
    },
    {
      "id": "get-view-logs",
      "name": "Get View Logs",
      "category": "Audit Events",
      "method": "POST",
      "path": "/api/archive/get-view-logs",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/auditevents/1/routes/api/archive/get-view-logs/post",
      "last_updated": "2025-12-12T14:43:30.041656+00:00"
    },
    {
      "id": "get-audit-events",
      "name": "Get Audit Events",
      "category": "Audit Events",
      "method": "POST",
      "path": "/api/audit/get-audit-events",
      "description": "Description Returns the audit events matching the request. Returns the audit events matching the request.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less categories array A list of audit category types. Use values from the \"code\" response field from the /api/audit/get-categories endpoint. If no categories are provided, all possible categories are returned. endDateTime (required) string (yyyy-MM-dd'T'HH:mm:ssZ) The end date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). query string A character string to search for the audit events. startDateTime (required) string (yyyy-MM-dd'T'HH:mm:ssZ) The start date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). Historical lookup is restricted to last 60 days.",
          "description": "categories array A list of audit category types. Use values from the \"code\" response field from the /api/audit/get-categories endpoint. If no categories are provided, all possible categories are returned. endDateTime (required) string (yyyy-MM-dd'T'HH:mm:ssZ) The end date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). query string A character string to search for the audit events. startDateTime (required) string (yyyy-MM-dd'T'HH:mm:ssZ) The start date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). Historical lookup is restricted to last 60 days."
        },
        {
          "name": "categories",
          "description": "array A list of audit category types. Use values from the \"code\" response field from the /api/audit/get-categories endpoint. If no categories are provided, all possible categories are returned."
        },
        {
          "name": "endDateTime (required)",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The end date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)."
        },
        {
          "name": "query",
          "description": "string A character string to search for the audit events."
        },
        {
          "name": "startDateTime (required)",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The start date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). Historical lookup is restricted to last 60 days."
        },
        {
          "name": "categories",
          "description": "array A list of audit category types. Use values from the \"code\" response field from the /api/audit/get-categories endpoint. If no categories are provided, all possible categories are returned."
        },
        {
          "name": "endDateTime (required)",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The end date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)."
        },
        {
          "name": "query",
          "description": "string A character string to search for the audit events."
        },
        {
          "name": "startDateTime (required)",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The start date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000). Historical lookup is restricted to last 60 days."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/auditevents/1/routes/api/audit/get-audit-events/post",
      "last_updated": "2025-12-12T14:43:31.329173+00:00"
    },
    {
      "id": "get-categories",
      "name": "Get Categories",
      "category": "Audit Events",
      "method": "POST",
      "path": "/api/audit/get-categories",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/auditevents/1/routes/api/audit/get-categories/post",
      "last_updated": "2025-12-12T14:43:32.601696+00:00"
    },
    {
      "id": "get-held-release-logs",
      "name": "Get Held Release Logs",
      "category": "Audit Events",
      "method": "POST",
      "path": "/api/gateway/get-held-release-logs",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/auditevents/1/routes/api/gateway/get-held-release-logs/post",
      "last_updated": "2025-12-12T14:43:33.871859+00:00"
    },
    {
      "id": "get-rejections",
      "name": "Get Rejections",
      "category": "Audit Events",
      "method": "POST",
      "path": "/api/gateway/get-rejections",
      "description": "Description This endpoint can be used to find rejected messages and the reasons for their rejection. This endpoint can be used to find rejected messages and the reasons for their rejection.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less admin boolean Specifies if the request is for an admin or user-level. If set to true, the request will return messages for all users. Default value is false. end string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of results to return in ISO 8601 format. Default value is the current date. mailbox string Get rejections for a given user. If admin is set to true and no mailbox is provided, will return rejections for all users. Otherwise if no mailbox is provided, then will return rejections for the authenticated account. searchBy object expand_less Accepts search filter field and value to apply when searching. fieldName string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp value string The value of which the filter will be applied start string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of results to return in ISO 8601 format. Default value is start of the current day.",
          "description": "admin boolean Specifies if the request is for an admin or user-level. If set to true, the request will return messages for all users. Default value is false. end string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of results to return in ISO 8601 format. Default value is the current date. mailbox string Get rejections for a given user. If admin is set to true and no mailbox is provided, will return rejections for all users. Otherwise if no mailbox is provided, then will return rejections for the authenticated account. searchBy object expand_less Accepts search filter field and value to apply when searching. fieldName string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp value string The value of which the filter will be applied fieldName string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp value string The value of which the filter will be applied start string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of results to return in ISO 8601 format. Default value is start of the current day."
        },
        {
          "name": "admin",
          "description": "boolean Specifies if the request is for an admin or user-level. If set to true, the request will return messages for all users. Default value is false."
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of results to return in ISO 8601 format. Default value is the current date."
        },
        {
          "name": "mailbox",
          "description": "string Get rejections for a given user. If admin is set to true and no mailbox is provided, will return rejections for all users. Otherwise if no mailbox is provided, then will return rejections for the authenticated account."
        },
        {
          "name": "searchBy",
          "description": "object expand_less Accepts search filter field and value to apply when searching."
        },
        {
          "name": "fieldName string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp value string The value of which the filter will be applied",
          "description": "fieldName string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp value string The value of which the filter will be applied"
        },
        {
          "name": "fieldName",
          "description": "string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp"
        },
        {
          "name": "value",
          "description": "string The value of which the filter will be applied"
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of results to return in ISO 8601 format. Default value is start of the current day."
        },
        {
          "name": "admin",
          "description": "boolean Specifies if the request is for an admin or user-level. If set to true, the request will return messages for all users. Default value is false."
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of results to return in ISO 8601 format. Default value is the current date."
        },
        {
          "name": "mailbox",
          "description": "string Get rejections for a given user. If admin is set to true and no mailbox is provided, will return rejections for all users. Otherwise if no mailbox is provided, then will return rejections for the authenticated account."
        },
        {
          "name": "searchBy",
          "description": "object expand_less Accepts search filter field and value to apply when searching."
        },
        {
          "name": "fieldName string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp value string The value of which the filter will be applied",
          "description": "fieldName string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp value string The value of which the filter will be applied"
        },
        {
          "name": "fieldName",
          "description": "string The field to be filtered on. Possible values are all, from, to, type, info, remoteIp"
        },
        {
          "name": "value",
          "description": "string The value of which the filter will be applied"
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of results to return in ISO 8601 format. Default value is start of the current day."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/auditevents/1/routes/api/gateway/get-rejections/post",
      "last_updated": "2025-12-12T14:43:35.237068+00:00"
    },
    {
      "id": "get-performance-details",
      "name": "Get Performance Details",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/company/get-performance-details",
      "description": "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). 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).",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain at most 1 item"
        },
        {
          "name": "object expand_less attributeIds array A list of Mimecast secure IDs for attributes to be used when searchBy is set to custome. A maximum of 3 attribute IDs can be provided. filterBy array expand_less Allows to filter by specific video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more or video_count_all. The default value is video_count_all. object expand_more includeUserDetails boolean If set to true, user details will be included in the response. The default value is false. searchBy array expand_less Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required. object expand_more",
          "description": "attributeIds array A list of Mimecast secure IDs for attributes to be used when searchBy is set to custome. A maximum of 3 attribute IDs can be provided. filterBy array expand_less Allows to filter by specific video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more or video_count_all. The default value is video_count_all. object expand_more includeUserDetails boolean If set to true, user details will be included in the response. The default value is false. searchBy array expand_less Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required. object expand_more"
        },
        {
          "name": "attributeIds",
          "description": "array A list of Mimecast secure IDs for attributes to be used when searchBy is set to custome. A maximum of 3 attribute IDs can be provided."
        },
        {
          "name": "filterBy",
          "description": "array expand_less Allows to filter by specific video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more or video_count_all. The default value is video_count_all."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "includeUserDetails",
          "description": "boolean If set to true, user details will be included in the response. The default value is false."
        },
        {
          "name": "searchBy",
          "description": "array expand_less Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "attributeIds",
          "description": "array A list of Mimecast secure IDs for attributes to be used when searchBy is set to custome. A maximum of 3 attribute IDs can be provided."
        },
        {
          "name": "filterBy",
          "description": "array expand_less Allows to filter by specific video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more or video_count_all. The default value is video_count_all."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "includeUserDetails",
          "description": "boolean If set to true, user details will be included in the response. The default value is false."
        },
        {
          "name": "searchBy",
          "description": "array expand_less Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required."
        },
        {
          "name": "object expand_more",
          "description": ""
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/company/get-performance-details/post",
      "last_updated": "2025-12-12T14:43:42.350565+00:00"
    },
    {
      "id": "get-performance-summary",
      "name": "Get Performance Summary",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/company/get-performance-summary",
      "description": "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) 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)",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less departmentCompletionStats array expand_less Breakdown of the completion status by company department. object expand_more numFourOrMoreIncorrect integer (int32) Total count of users that have answered 4 or more training videos incorrectly. numOneIncorrect integer (int32) Total count of users that have answered one training video incorrectly. numParticipating integer (int32) Total count of the users participating in training. numThreeIncorrect integer (int32) Total count of users that have answered 3 training videos incorrectly. numTwoIncorrect integer (int32) Total count of users that have answered two training videos incorrectly. numVideosNotWatched integer (int32) Total count of the vidoes that have not yet been watched by users. numVideosSent integer (int32) Total count of the vidoes sent out to users. numZeroIncorrect integer (int32) Total count of users that have not answered any questions incorrectly.",
          "description": "departmentCompletionStats array expand_less Breakdown of the completion status by company department. object expand_more numFourOrMoreIncorrect integer (int32) Total count of users that have answered 4 or more training videos incorrectly. numOneIncorrect integer (int32) Total count of users that have answered one training video incorrectly. numParticipating integer (int32) Total count of the users participating in training. numThreeIncorrect integer (int32) Total count of users that have answered 3 training videos incorrectly. numTwoIncorrect integer (int32) Total count of users that have answered two training videos incorrectly. numVideosNotWatched integer (int32) Total count of the vidoes that have not yet been watched by users. numVideosSent integer (int32) Total count of the vidoes sent out to users. numZeroIncorrect integer (int32) Total count of users that have not answered any questions incorrectly."
        },
        {
          "name": "departmentCompletionStats",
          "description": "array expand_less Breakdown of the completion status by company department."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "numFourOrMoreIncorrect",
          "description": "integer (int32) Total count of users that have answered 4 or more training videos incorrectly."
        },
        {
          "name": "numOneIncorrect",
          "description": "integer (int32) Total count of users that have answered one training video incorrectly."
        },
        {
          "name": "numParticipating",
          "description": "integer (int32) Total count of the users participating in training."
        },
        {
          "name": "numThreeIncorrect",
          "description": "integer (int32) Total count of users that have answered 3 training videos incorrectly."
        },
        {
          "name": "numTwoIncorrect",
          "description": "integer (int32) Total count of users that have answered two training videos incorrectly."
        },
        {
          "name": "numVideosNotWatched",
          "description": "integer (int32) Total count of the vidoes that have not yet been watched by users."
        },
        {
          "name": "numVideosSent",
          "description": "integer (int32) Total count of the vidoes sent out to users."
        },
        {
          "name": "numZeroIncorrect",
          "description": "integer (int32) Total count of users that have not answered any questions incorrectly."
        },
        {
          "name": "fail",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less errors array expand_less object expand_more key object The request item associated with this error",
          "description": "errors array expand_less object expand_more key object The request item associated with this error"
        },
        {
          "name": "errors",
          "description": "array expand_less"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "key",
          "description": "object The request item associated with this error"
        },
        {
          "name": "departmentCompletionStats",
          "description": "array expand_less Breakdown of the completion status by company department."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "numFourOrMoreIncorrect",
          "description": "integer (int32) Total count of users that have answered 4 or more training videos incorrectly."
        },
        {
          "name": "numOneIncorrect",
          "description": "integer (int32) Total count of users that have answered one training video incorrectly."
        },
        {
          "name": "numParticipating",
          "description": "integer (int32) Total count of the users participating in training."
        },
        {
          "name": "numThreeIncorrect",
          "description": "integer (int32) Total count of users that have answered 3 training videos incorrectly."
        },
        {
          "name": "numTwoIncorrect",
          "description": "integer (int32) Total count of users that have answered two training videos incorrectly."
        },
        {
          "name": "numVideosNotWatched",
          "description": "integer (int32) Total count of the vidoes that have not yet been watched by users."
        },
        {
          "name": "numVideosSent",
          "description": "integer (int32) Total count of the vidoes sent out to users."
        },
        {
          "name": "numZeroIncorrect",
          "description": "integer (int32) Total count of users that have not answered any questions incorrectly."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/company/get-performance-summary/post",
      "last_updated": "2025-12-12T14:43:43.772171+00:00"
    },
    {
      "id": "get-safe-score-details",
      "name": "Get Safe Score Details",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/company/get-safe-score-details",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/company/get-safe-score-details/post",
      "last_updated": "2025-12-12T14:43:45.050690+00:00"
    },
    {
      "id": "get-safe-score-summary",
      "name": "Get Safe Score Summary",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/company/get-safe-score-summary",
      "description": "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) 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)",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less scoreCounts object An object containing the count of each letter grade score, from A-F.",
          "description": "scoreCounts object An object containing the count of each letter grade score, from A-F."
        },
        {
          "name": "scoreCounts",
          "description": "object An object containing the count of each letter grade score, from A-F."
        },
        {
          "name": "fail",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less errors array expand_less object expand_more key object The request item associated with this error",
          "description": "errors array expand_less object expand_more key object The request item associated with this error"
        },
        {
          "name": "errors",
          "description": "array expand_less"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "key",
          "description": "object The request item associated with this error"
        },
        {
          "name": "scoreCounts",
          "description": "object An object containing the count of each letter grade score, from A-F."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/company/get-safe-score-summary/post",
      "last_updated": "2025-12-12T14:43:46.354505+00:00"
    },
    {
      "id": "get-watchlist-details",
      "name": "Get Watchlist Details",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/company/get-watchlist-details",
      "description": "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) 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)",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain at most 1 item"
        },
        {
          "name": "object expand_less attributeIds array A list of Mimecast secure IDs for attributes to be used when searchBy is set to custom. A maximum of 3 attribute IDs can be provided. filterBy array expand_less Allows filtering by specific watchlist video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more, video_count_1_or_more. If filterBy is not set, the endpoint will default to video_count_1_or_more. object expand_more searchBy array expand_less Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required. object expand_more",
          "description": "attributeIds array A list of Mimecast secure IDs for attributes to be used when searchBy is set to custom. A maximum of 3 attribute IDs can be provided. filterBy array expand_less Allows filtering by specific watchlist video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more, video_count_1_or_more. If filterBy is not set, the endpoint will default to video_count_1_or_more. object expand_more searchBy array expand_less Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required. object expand_more"
        },
        {
          "name": "attributeIds",
          "description": "array A list of Mimecast secure IDs for attributes to be used when searchBy is set to custom. A maximum of 3 attribute IDs can be provided."
        },
        {
          "name": "filterBy",
          "description": "array expand_less Allows filtering by specific watchlist video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more, video_count_1_or_more. If filterBy is not set, the endpoint will default to video_count_1_or_more."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "searchBy",
          "description": "array expand_less Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "attributeIds",
          "description": "array A list of Mimecast secure IDs for attributes to be used when searchBy is set to custom. A maximum of 3 attribute IDs can be provided."
        },
        {
          "name": "filterBy",
          "description": "array expand_less Allows filtering by specific watchlist video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more, video_count_1_or_more. If filterBy is not set, the endpoint will default to video_count_1_or_more."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "searchBy",
          "description": "array expand_less Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required."
        },
        {
          "name": "object expand_more",
          "description": ""
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/company/get-watchlist-details/post",
      "last_updated": "2025-12-12T14:43:47.699751+00:00"
    },
    {
      "id": "get-watchlist-summary",
      "name": "Get Watchlist Summary",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/company/get-watchlist-summary",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/company/get-watchlist-summary/post",
      "last_updated": "2025-12-12T14:43:48.982312+00:00"
    },
    {
      "id": "get-campaign",
      "name": "Get Campaign",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/phishing/campaign/get-campaign",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/phishing/campaign/get-campaign/post",
      "last_updated": "2025-12-12T14:43:50.278663+00:00"
    },
    {
      "id": "get-user-data",
      "name": "Get User Data",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/phishing/campaign/get-user-data",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/phishing/campaign/get-user-data/post",
      "last_updated": "2025-12-12T14:43:51.567038+00:00"
    },
    {
      "id": "queue-get-queue",
      "name": "Queue/Get Queue",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/queue/get-queue",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/queue/get-queue/post",
      "last_updated": "2025-12-12T14:43:52.842149+00:00"
    },
    {
      "id": "user-get-training-details",
      "name": "User/Get Training Details",
      "category": "Awareness Training",
      "method": "POST",
      "path": "/api/awareness-training/user/get-training-details",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api/awareness-training/user/get-training-details/post",
      "last_updated": "2025-12-12T14:43:54.110353+00:00"
    },
    {
      "id": "connectors",
      "name": "Connectors",
      "category": "Connector",
      "method": "GET",
      "path": "/connector/cloud-gateway/v1/connectors",
      "description": "Description Fetches all existing Connectors information for an account. Fetches all existing Connectors information for an account. Please note that this endpoint only work for Directory Synchronisation - Azure Standard and Azure GCC High Connectors creation. Please note Please note that this endpoint only work for Directory Synchronisation - Azure Standard and Azure GCC High Connectors creation.",
      "parameters": [
        {
          "name": "pageToken",
          "description": "string Pagination page token"
        },
        {
          "name": "pageSize",
          "description": "integer (int32) Pagination page size"
        },
        {
          "name": "connectors",
          "description": "array expand_less List of connectors for account"
        },
        {
          "name": "object expand_less id string ID of the directory connection. name string Connector name product object expand_less The product linked to this connector id string ID of the product name string Name of the product provider string Provider used by this connector The following values are allowed: exchange_web_services, office_365, ms_teams, one_drive, sharepoint, box_skill, google_workspace, ms_teams_bot, internal, azure_standard, azure_gcc, office_365_gcc, ms_teams_gcc status string The status of this connector The following values are allowed: configured, connected, error",
          "description": "id string ID of the directory connection. name string Connector name product object expand_less The product linked to this connector id string ID of the product name string Name of the product id string ID of the product name string Name of the product provider string Provider used by this connector The following values are allowed: exchange_web_services, office_365, ms_teams, one_drive, sharepoint, box_skill, google_workspace, ms_teams_bot, internal, azure_standard, azure_gcc, office_365_gcc, ms_teams_gcc status string The status of this connector The following values are allowed: configured, connected, error"
        },
        {
          "name": "id",
          "description": "string ID of the directory connection."
        },
        {
          "name": "name",
          "description": "string Connector name"
        },
        {
          "name": "product",
          "description": "object expand_less The product linked to this connector"
        },
        {
          "name": "id string ID of the product name string Name of the product",
          "description": "id string ID of the product name string Name of the product"
        },
        {
          "name": "id",
          "description": "string ID of the product"
        },
        {
          "name": "name",
          "description": "string Name of the product"
        },
        {
          "name": "provider",
          "description": "string Provider used by this connector The following values are allowed: exchange_web_services, office_365, ms_teams, one_drive, sharepoint, box_skill, google_workspace, ms_teams_bot, internal, azure_standard, azure_gcc, office_365_gcc, ms_teams_gcc"
        },
        {
          "name": "status",
          "description": "string The status of this connector The following values are allowed: configured, connected, error"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/connector/1/routes/connector/cloud-gateway/v1/connectors/get",
      "last_updated": "2025-12-12T14:44:01.031755+00:00"
    },
    {
      "id": "connectors",
      "name": "Connectors",
      "category": "Connector",
      "method": "POST",
      "path": "/connector/cloud-gateway/v1/connectors",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/connector/1/routes/connector/cloud-gateway/v1/connectors/post",
      "last_updated": "2025-12-12T14:44:02.308035+00:00"
    },
    {
      "id": "{connector_id}",
      "name": "{Connector_Id}",
      "category": "Connector",
      "method": "GET",
      "path": "/connector/cloud-gateway/v1/connectors/{connector_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/connector/1/routes/connector/cloud-gateway/v1/connectors/%7Bconnector_id%7D/get",
      "last_updated": "2025-12-12T14:44:03.585333+00:00"
    },
    {
      "id": "{connector_id}",
      "name": "{Connector_Id}",
      "category": "Connector",
      "method": "PATCH",
      "path": "/connector/cloud-gateway/v1/connectors/{connector_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/connector/1/routes/connector/cloud-gateway/v1/connectors/%7Bconnector_id%7D/patch",
      "last_updated": "2025-12-12T14:44:04.860114+00:00"
    },
    {
      "id": "{connector_id}",
      "name": "{Connector_Id}",
      "category": "Connector",
      "method": "DELETE",
      "path": "/connector/cloud-gateway/v1/connectors/{connector_id}",
      "description": "Description Deletes an existing Connector. Deletes an existing Connector. Please note that this endpoint only work for Directory Synchronisation - Azure Standard and Azure GCC High Connectors creation. Please note Please note that this endpoint only work for Directory Synchronisation - Azure Standard and Azure GCC High Connectors creation.",
      "parameters": [
        {
          "name": "CONNECTOR_ID (required)",
          "description": "string Connector ID."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/connector/1/routes/connector/cloud-gateway/v1/connectors/%7Bconnector_id%7D/delete",
      "last_updated": "2025-12-12T14:44:06.131232+00:00"
    },
    {
      "id": "get-file",
      "name": "Get File",
      "category": "Archive Data Access",
      "method": "POST",
      "path": "/api/archive/get-file",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/archivedataaccess/1/routes/api/archive/get-file/post",
      "last_updated": "2025-12-12T14:44:12.322006+00:00"
    },
    {
      "id": "get-message-detail",
      "name": "Get Message Detail",
      "category": "Archive Data Access",
      "method": "POST",
      "path": "/api/archive/get-message-detail",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/archivedataaccess/1/routes/api/archive/get-message-detail/post",
      "last_updated": "2025-12-12T14:44:13.602548+00:00"
    },
    {
      "id": "get-message-list",
      "name": "Get Message List",
      "category": "Archive Data Access",
      "method": "POST",
      "path": "/api/archive/get-message-list",
      "description": "Description Retrieves archive message list. Retrieves archive message list.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less end string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the end of the current day. includeAliases boolean Include messages for alias addresses of the mailbox. Default true. includeDelegates boolean Include messages for addresses that the mailbox has delegate permissions to. Default false. mailbox string The email address to return the message list for. If excluded, then messages for the logged in user are returned. start string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the last calendar month. view string The message list type, must be one of: INBOX or SENT The following values are allowed: INBOX, SENT",
          "description": "end string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the end of the current day. includeAliases boolean Include messages for alias addresses of the mailbox. Default true. includeDelegates boolean Include messages for addresses that the mailbox has delegate permissions to. Default false. mailbox string The email address to return the message list for. If excluded, then messages for the logged in user are returned. start string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the last calendar month. view string The message list type, must be one of: INBOX or SENT The following values are allowed: INBOX, SENT"
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the end of the current day."
        },
        {
          "name": "includeAliases",
          "description": "boolean Include messages for alias addresses of the mailbox. Default true."
        },
        {
          "name": "includeDelegates",
          "description": "boolean Include messages for addresses that the mailbox has delegate permissions to. Default false."
        },
        {
          "name": "mailbox",
          "description": "string The email address to return the message list for. If excluded, then messages for the logged in user are returned."
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the last calendar month."
        },
        {
          "name": "view",
          "description": "string The message list type, must be one of: INBOX or SENT The following values are allowed: INBOX, SENT"
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the end of the current day."
        },
        {
          "name": "includeAliases",
          "description": "boolean Include messages for alias addresses of the mailbox. Default true."
        },
        {
          "name": "includeDelegates",
          "description": "boolean Include messages for addresses that the mailbox has delegate permissions to. Default false."
        },
        {
          "name": "mailbox",
          "description": "string The email address to return the message list for. If excluded, then messages for the logged in user are returned."
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of messages to return, in the following format, 2015-11-16T14:49:18+0000. Default is the last calendar month."
        },
        {
          "name": "view",
          "description": "string The message list type, must be one of: INBOX or SENT The following values are allowed: INBOX, SENT"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/archivedataaccess/1/routes/api/archive/get-message-list/post",
      "last_updated": "2025-12-12T14:44:14.889731+00:00"
    },
    {
      "id": "get-message-part",
      "name": "Get Message Part",
      "category": "Archive Data Access",
      "method": "POST",
      "path": "/api/archive/get-message-part",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/archivedataaccess/1/routes/api/archive/get-message-part/post",
      "last_updated": "2025-12-12T14:44:16.159736+00:00"
    },
    {
      "id": "search",
      "name": "Search",
      "category": "Archive Data Access",
      "method": "POST",
      "path": "/api/archive/search",
      "description": "Description Retrieves archive search items. Retrieves archive search items.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less admin boolean Defines if the search is an administrative search or an end user user search. Defaults to false. query (required) string The query string for the search. Please see the Building Search Queries guide for more information on building search queries.",
          "description": "admin boolean Defines if the search is an administrative search or an end user user search. Defaults to false. query (required) string The query string for the search. Please see the Building Search Queries guide for more information on building search queries."
        },
        {
          "name": "admin",
          "description": "boolean Defines if the search is an administrative search or an end user user search. Defaults to false."
        },
        {
          "name": "query (required)",
          "description": "string The query string for the search. Please see the Building Search Queries guide for more information on building search queries."
        },
        {
          "name": "admin",
          "description": "boolean Defines if the search is an administrative search or an end user user search. Defaults to false."
        },
        {
          "name": "query (required)",
          "description": "string The query string for the search. Please see the Building Search Queries guide for more information on building search queries."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/archivedataaccess/1/routes/api/archive/search/post",
      "last_updated": "2025-12-12T14:44:17.442075+00:00"
    },
    {
      "id": "create-domain",
      "name": "Create Domain",
      "category": "Domain Management",
      "method": "POST",
      "path": "/api/domain/create-domain",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/api/domain/create-domain/post",
      "last_updated": "2025-12-12T14:44:24.770850+00:00"
    },
    {
      "id": "delete-pending-domain",
      "name": "Delete Pending Domain",
      "category": "Domain Management",
      "method": "POST",
      "path": "/api/domain/delete-pending-domain",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/api/domain/delete-pending-domain/post",
      "last_updated": "2025-12-12T14:44:26.059652+00:00"
    },
    {
      "id": "get-internal-domain",
      "name": "Get Internal Domain",
      "category": "Domain Management",
      "method": "POST",
      "path": "/api/domain/get-internal-domain",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/api/domain/get-internal-domain/post",
      "last_updated": "2025-12-12T14:44:27.331676+00:00"
    },
    {
      "id": "get-pending-domain",
      "name": "Get Pending Domain",
      "category": "Domain Management",
      "method": "POST",
      "path": "/api/domain/get-pending-domain",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/api/domain/get-pending-domain/post",
      "last_updated": "2025-12-12T14:44:28.675118+00:00"
    },
    {
      "id": "get-provision-status",
      "name": "Get Provision Status",
      "category": "Domain Management",
      "method": "POST",
      "path": "/api/domain/get-provision-status",
      "description": null,
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  from 1 to 50 items"
        },
        {
          "name": "object expand_less domain (required) string The domain name to return (without '@').",
          "description": "domain (required) string The domain name to return (without '@')."
        },
        {
          "name": "domain (required)",
          "description": "string The domain name to return (without '@')."
        },
        {
          "name": "domain (required)",
          "description": "string The domain name to return (without '@')."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/api/domain/get-provision-status/post",
      "last_updated": "2025-12-12T14:44:29.988071+00:00"
    },
    {
      "id": "get-verification-code",
      "name": "Get Verification Code",
      "category": "Domain Management",
      "method": "POST",
      "path": "/api/domain/get-verification-code",
      "description": null,
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  from 1 to 50 items"
        },
        {
          "name": "object expand_less domain (required) string The domain name to return (without '@').",
          "description": "domain (required) string The domain name to return (without '@')."
        },
        {
          "name": "domain (required)",
          "description": "string The domain name to return (without '@')."
        },
        {
          "name": "domain (required)",
          "description": "string The domain name to return (without '@')."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/api/domain/get-verification-code/post",
      "last_updated": "2025-12-12T14:44:31.298709+00:00"
    },
    {
      "id": "verify-domain",
      "name": "Verify Domain",
      "category": "Domain Management",
      "method": "POST",
      "path": "/api/domain/verify-domain",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/api/domain/verify-domain/post",
      "last_updated": "2025-12-12T14:44:32.575492+00:00"
    },
    {
      "id": "external-domains",
      "name": "External Domains",
      "category": "Domain Management",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/external-domains",
      "description": "Description Gets a list all external domains. Gets a list all external domains.",
      "parameters": [
        {
          "name": "pageSize",
          "description": "integer (int32) 1 \u2264 value \u2264 100 The maximum number of rows to return per page."
        },
        {
          "name": "pageToken",
          "description": "Example open_in_new NDY6bnVsbA== NDY6bnVsbA== content_copy string Pagination page token"
        },
        {
          "name": "domains",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less id string Domain id. domain string Domain name.",
          "description": "id string Domain id. domain string Domain name."
        },
        {
          "name": "id",
          "description": "string Domain id."
        },
        {
          "name": "domain",
          "description": "string Domain name."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/external-domains/get",
      "last_updated": "2025-12-12T14:44:33.871339+00:00"
    },
    {
      "id": "external-domains-{domain_id}",
      "name": "External Domains/{Domain_Id}",
      "category": "Domain Management",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/external-domains/{domain_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/external-domains/%7Bdomain_id%7D/get",
      "last_updated": "2025-12-12T14:44:35.140435+00:00"
    },
    {
      "id": "internal-domains",
      "name": "Internal Domains",
      "category": "Domain Management",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/internal-domains",
      "description": "Description Gets a list all internal domains. Gets a list all internal domains.",
      "parameters": [
        {
          "name": "pageSize",
          "description": "integer (int32) 1 \u2264 value \u2264 100 The maximum number of rows to return per page."
        },
        {
          "name": "pageToken",
          "description": "Example open_in_new NDY6bnVsbA== NDY6bnVsbA== content_copy string Pagination page token"
        },
        {
          "name": "domains",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less id string Domain id. domain string Domain name. local boolean Whether the domain is local. sendOnly boolean Whether the domain is send-only. inboundType string Inbound type - any (Accept Any Address), smtp (SMTP Call Forward), ldap (LDAP Users Only), known (Known Recipients Only), backup_mx (Act as backup MX), smtp_null (SMTP Call forward with null sender (<>) to check recipient addresses). The following values are allowed: any, smtp, ldap, known, backup_mx, smtp_null",
          "description": "id string Domain id. domain string Domain name. local boolean Whether the domain is local. sendOnly boolean Whether the domain is send-only. inboundType string Inbound type - any (Accept Any Address), smtp (SMTP Call Forward), ldap (LDAP Users Only), known (Known Recipients Only), backup_mx (Act as backup MX), smtp_null (SMTP Call forward with null sender (<>) to check recipient addresses). The following values are allowed: any, smtp, ldap, known, backup_mx, smtp_null"
        },
        {
          "name": "id",
          "description": "string Domain id."
        },
        {
          "name": "domain",
          "description": "string Domain name."
        },
        {
          "name": "local",
          "description": "boolean Whether the domain is local."
        },
        {
          "name": "sendOnly",
          "description": "boolean Whether the domain is send-only."
        },
        {
          "name": "inboundType",
          "description": "string Inbound type - any (Accept Any Address), smtp (SMTP Call Forward), ldap (LDAP Users Only), known (Known Recipients Only), backup_mx (Act as backup MX), smtp_null (SMTP Call forward with null sender (<>) to check recipient addresses). The following values are allowed: any, smtp, ldap, known, backup_mx, smtp_null"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/internal-domains/get",
      "last_updated": "2025-12-12T14:44:36.438164+00:00"
    },
    {
      "id": "{domain_id}",
      "name": "{Domain_Id}",
      "category": "Domain Management",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/internal-domains/{domain_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/internal-domains/%7Bdomain_id%7D/get",
      "last_updated": "2025-12-12T14:44:37.726204+00:00"
    },
    {
      "id": "{domain_id}",
      "name": "{Domain_Id}",
      "category": "Domain Management",
      "method": "PATCH",
      "path": "/domain/cloud-gateway/v1/internal-domains/{domain_id}",
      "description": "Description Updates an internal domain. Updates an internal domain.",
      "parameters": [
        {
          "name": "domain_id (required)",
          "description": "string Domain id."
        },
        {
          "name": "inboundType (required)",
          "description": "string Inbound type - any (Accept Any Address), smtp (SMTP Call Forward), ldap (LDAP Users Only), known (Known Recipients Only), backup_mx (Act as backup MX), smtp_null (SMTP Call forward with null sender (<>) to check recipient addresses). The following values are allowed: any, smtp, ldap, known, backup_mx, smtp_null"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/internal-domains/%7Bdomain_id%7D/patch",
      "last_updated": "2025-12-12T14:44:39.011446+00:00"
    },
    {
      "id": "{domain_id}-dns-records-{record_type}",
      "name": "{Domain_Id}/Dns Records/{Record_Type}",
      "category": "Domain Management",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/internal-domains/{domain_id}/dns-records/{record_type}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/internal-domains/%7Bdomain_id%7D/dns-records/%7Brecord_type%7D/get",
      "last_updated": "2025-12-12T14:44:40.290163+00:00"
    },
    {
      "id": "verify",
      "name": "Verify",
      "category": "Domain Management",
      "method": "POST",
      "path": "/domain/cloud-gateway/v1/internal-domains/verify",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/internal-domains/verify/post",
      "last_updated": "2025-12-12T14:44:41.575743+00:00"
    },
    {
      "id": "pending-domains",
      "name": "Pending Domains",
      "category": "Domain Management",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/pending-domains",
      "description": "Description Gets all pending domains. Gets all pending domains.",
      "parameters": [
        {
          "name": "pageSize",
          "description": "integer (int32) 1 \u2264 value \u2264 100 The maximum number of rows to return per page."
        },
        {
          "name": "pageToken",
          "description": "Example open_in_new NDY6bnVsbA== NDY6bnVsbA== content_copy string Pagination page token"
        },
        {
          "name": "domains",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less id string Domain id - if created as internal domain. domain string The pending domain requested (without the @). token string Domain provisioning token -- the verification code to be added to the MX record.\" local boolean Whether the domain is local. createdDateTime string (date-time) When the domain was created. Format yyyy-MM-dd'T'HH:mm:ssZ. expiryDateTime string (date-time) When the MX record verification code will expire. Format yyyy-MM-dd'T'HH:mm:ssZ. sendOnly boolean Whether the domain is send-only.",
          "description": "id string Domain id - if created as internal domain. domain string The pending domain requested (without the @). token string Domain provisioning token -- the verification code to be added to the MX record.\" local boolean Whether the domain is local. createdDateTime string (date-time) When the domain was created. Format yyyy-MM-dd'T'HH:mm:ssZ. expiryDateTime string (date-time) When the MX record verification code will expire. Format yyyy-MM-dd'T'HH:mm:ssZ. sendOnly boolean Whether the domain is send-only."
        },
        {
          "name": "id",
          "description": "string Domain id - if created as internal domain."
        },
        {
          "name": "domain",
          "description": "string The pending domain requested (without the @)."
        },
        {
          "name": "token",
          "description": "string Domain provisioning token -- the verification code to be added to the MX record.\""
        },
        {
          "name": "local",
          "description": "boolean Whether the domain is local."
        },
        {
          "name": "createdDateTime",
          "description": "string (date-time) When the domain was created. Format yyyy-MM-dd'T'HH:mm:ssZ."
        },
        {
          "name": "expiryDateTime",
          "description": "string (date-time) When the MX record verification code will expire. Format yyyy-MM-dd'T'HH:mm:ssZ."
        },
        {
          "name": "sendOnly",
          "description": "boolean Whether the domain is send-only."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/pending-domains/get",
      "last_updated": "2025-12-12T14:44:42.886725+00:00"
    },
    {
      "id": "pending-domains",
      "name": "Pending Domains",
      "category": "Domain Management",
      "method": "POST",
      "path": "/domain/cloud-gateway/v1/pending-domains",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/pending-domains/post",
      "last_updated": "2025-12-12T14:44:44.157047+00:00"
    },
    {
      "id": "{domain_id}",
      "name": "{Domain_Id}",
      "category": "Domain Management",
      "method": "DELETE",
      "path": "/domain/cloud-gateway/v1/pending-domains/{domain_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/pending-domains/%7Bdomain_id%7D/delete",
      "last_updated": "2025-12-12T14:44:46.713369+00:00"
    },
    {
      "id": "generate-token",
      "name": "Generate Token",
      "category": "Domain Management",
      "method": "POST",
      "path": "/domain/cloud-gateway/v1/pending-domains/generate-token",
      "description": "Description Returns the code to be added to TXT records of the new domain and also extends the expiry of the code to 30 days from the time of the request. Returns the code to be added to TXT records of the new domain and also extends the expiry of the code to 30 days from the time of the request.",
      "parameters": [
        {
          "name": "domains",
          "description": "array must contain  from 1 to 50 items"
        },
        {
          "name": "results",
          "description": "array expand_less List of domains, their tokens and the status."
        },
        {
          "name": "object expand_less domain string Name of domain. token string The provision token for the domain. This is to be added to the TXT record, enabling Mimecast to verify the ownership of the domain. status string The status of the expiry extension The following values are allowed: extended, failed",
          "description": "domain string Name of domain. token string The provision token for the domain. This is to be added to the TXT record, enabling Mimecast to verify the ownership of the domain. status string The status of the expiry extension The following values are allowed: extended, failed"
        },
        {
          "name": "domain",
          "description": "string Name of domain."
        },
        {
          "name": "token",
          "description": "string The provision token for the domain. This is to be added to the TXT record, enabling Mimecast to verify the ownership of the domain."
        },
        {
          "name": "status",
          "description": "string The status of the expiry extension The following values are allowed: extended, failed"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/domainmanagement/1/routes/domain/cloud-gateway/v1/pending-domains/generate-token/post",
      "last_updated": "2025-12-12T14:44:48.015934+00:00"
    },
    {
      "id": "get-email-queues",
      "name": "Get Email Queues",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/email/get-email-queues",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/email/get-email-queues/post",
      "last_updated": "2025-12-12T14:44:58.362351+00:00"
    },
    {
      "id": "send-email",
      "name": "Send Email",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/email/send-email",
      "description": "Description This API endpoint can be used to send an email. This API endpoint can be used to send an email.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  from 1 to 500 items"
        },
        {
          "name": "object expand_less attachments array expand_less List of attachment details object expand_more bcc array expand_less List of recipient's email addresses as BCC object expand_more cc array expand_less List of recipient's email addresses as CC object expand_more extraHeaders array expand_less Email headers object expand_more from object expand_less The email address used is always the caller's email address. In this context, it will be the Service Principal of the API application. displayableName string emailAddress (required) string htmlBody object expand_less HTML part of email body charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part inReplyTo string plainBody object expand_less Plain text part of email body charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part subject (required) string Email subject to (required) array expand_less List of recipient's email addresses as TO object expand_more",
          "description": "attachments array expand_less List of attachment details object expand_more bcc array expand_less List of recipient's email addresses as BCC object expand_more cc array expand_less List of recipient's email addresses as CC object expand_more extraHeaders array expand_less Email headers object expand_more from object expand_less The email address used is always the caller's email address. In this context, it will be the Service Principal of the API application. displayableName string emailAddress (required) string displayableName string emailAddress (required) string htmlBody object expand_less HTML part of email body charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part inReplyTo string plainBody object expand_less Plain text part of email body charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part subject (required) string Email subject to (required) array expand_less List of recipient's email addresses as TO object expand_more"
        },
        {
          "name": "attachments",
          "description": "array expand_less List of attachment details"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "bcc",
          "description": "array expand_less List of recipient's email addresses as BCC"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "cc",
          "description": "array expand_less List of recipient's email addresses as CC"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "extraHeaders",
          "description": "array expand_less Email headers"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "from",
          "description": "object expand_less The email address used is always the caller's email address. In this context, it will be the Service Principal of the API application."
        },
        {
          "name": "displayableName string emailAddress (required) string",
          "description": "displayableName string emailAddress (required) string"
        },
        {
          "name": "displayableName",
          "description": "string"
        },
        {
          "name": "emailAddress (required)",
          "description": "string"
        },
        {
          "name": "htmlBody",
          "description": "object expand_less HTML part of email body"
        },
        {
          "name": "charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part",
          "description": "charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part"
        },
        {
          "name": "charset",
          "description": "string"
        },
        {
          "name": "content",
          "description": "string Content of body part"
        },
        {
          "name": "contentDisposition",
          "description": "string"
        },
        {
          "name": "contentTransferEncoding",
          "description": "string"
        },
        {
          "name": "contentType",
          "description": "string"
        },
        {
          "name": "extraHeaders",
          "description": "array expand_more"
        },
        {
          "name": "id",
          "description": "string Secure file token in case it represent body part"
        },
        {
          "name": "inReplyTo",
          "description": "string"
        },
        {
          "name": "plainBody",
          "description": "object expand_less Plain text part of email body"
        },
        {
          "name": "charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part",
          "description": "charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part"
        },
        {
          "name": "charset",
          "description": "string"
        },
        {
          "name": "content",
          "description": "string Content of body part"
        },
        {
          "name": "contentDisposition",
          "description": "string"
        },
        {
          "name": "contentTransferEncoding",
          "description": "string"
        },
        {
          "name": "contentType",
          "description": "string"
        },
        {
          "name": "extraHeaders",
          "description": "array expand_more"
        },
        {
          "name": "id",
          "description": "string Secure file token in case it represent body part"
        },
        {
          "name": "subject (required)",
          "description": "string Email subject"
        },
        {
          "name": "to (required)",
          "description": "array expand_less List of recipient's email addresses as TO"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "attachments",
          "description": "array expand_less List of attachment details"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "bcc",
          "description": "array expand_less List of recipient's email addresses as BCC"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "cc",
          "description": "array expand_less List of recipient's email addresses as CC"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "extraHeaders",
          "description": "array expand_less Email headers"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "from",
          "description": "object expand_less The email address used is always the caller's email address. In this context, it will be the Service Principal of the API application."
        },
        {
          "name": "displayableName string emailAddress (required) string",
          "description": "displayableName string emailAddress (required) string"
        },
        {
          "name": "displayableName",
          "description": "string"
        },
        {
          "name": "emailAddress (required)",
          "description": "string"
        },
        {
          "name": "htmlBody",
          "description": "object expand_less HTML part of email body"
        },
        {
          "name": "charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part",
          "description": "charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part"
        },
        {
          "name": "charset",
          "description": "string"
        },
        {
          "name": "content",
          "description": "string Content of body part"
        },
        {
          "name": "contentDisposition",
          "description": "string"
        },
        {
          "name": "contentTransferEncoding",
          "description": "string"
        },
        {
          "name": "contentType",
          "description": "string"
        },
        {
          "name": "extraHeaders",
          "description": "array expand_more"
        },
        {
          "name": "id",
          "description": "string Secure file token in case it represent body part"
        },
        {
          "name": "inReplyTo",
          "description": "string"
        },
        {
          "name": "plainBody",
          "description": "object expand_less Plain text part of email body"
        },
        {
          "name": "charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part",
          "description": "charset string content string Content of body part contentDisposition string contentTransferEncoding string contentType string extraHeaders array expand_more id string Secure file token in case it represent body part"
        },
        {
          "name": "charset",
          "description": "string"
        },
        {
          "name": "content",
          "description": "string Content of body part"
        },
        {
          "name": "contentDisposition",
          "description": "string"
        },
        {
          "name": "contentTransferEncoding",
          "description": "string"
        },
        {
          "name": "contentType",
          "description": "string"
        },
        {
          "name": "extraHeaders",
          "description": "array expand_more"
        },
        {
          "name": "id",
          "description": "string Secure file token in case it represent body part"
        },
        {
          "name": "subject (required)",
          "description": "string Email subject"
        },
        {
          "name": "to (required)",
          "description": "array expand_less List of recipient's email addresses as TO"
        },
        {
          "name": "object expand_more",
          "description": ""
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/email/send-email/post",
      "last_updated": "2025-12-12T14:44:59.725622+00:00"
    },
    {
      "id": "file-file-upload",
      "name": "File/File Upload",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/file/file-upload",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/file/file-upload/post",
      "last_updated": "2025-12-12T14:45:01.041047+00:00"
    },
    {
      "id": "find-processing-messages",
      "name": "Find Processing Messages",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/gateway/find-processing-messages",
      "description": "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 . 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 Mimecaster Central Mimecaster Central . All request fields are optional, however at least one option must be presented in the request body. All request fields are optional, however at least one option must be presented in the request body.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less end string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of results to return in ISO 8601 format. Default value is the current date. filterBy array expand_less Filters by route and attachment to apply to results. object expand_more searchBy object expand_less Accepts search filter field and value to apply when searching. fieldName string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp. value string The search value to be used. sortBy string The field to sort results by. Must be createTime. The following values are allowed: createTime sortOrder string Sort results in order according to date. Possible values are ascending or descending, with descending being the default value. The following values are allowed: asc, desc start string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of results to return in ISO 8601 format. Default value is 7 days prior to current date. type string The message queue type to return. Possible values are processing, bulk_processing with the default value being processing. The following values are allowed: processing, bulk_processing",
          "description": "end string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of results to return in ISO 8601 format. Default value is the current date. filterBy array expand_less Filters by route and attachment to apply to results. object expand_more searchBy object expand_less Accepts search filter field and value to apply when searching. fieldName string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp. value string The search value to be used. fieldName string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp. value string The search value to be used. sortBy string The field to sort results by. Must be createTime. The following values are allowed: createTime sortOrder string Sort results in order according to date. Possible values are ascending or descending, with descending being the default value. The following values are allowed: asc, desc start string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of results to return in ISO 8601 format. Default value is 7 days prior to current date. type string The message queue type to return. Possible values are processing, bulk_processing with the default value being processing. The following values are allowed: processing, bulk_processing"
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of results to return in ISO 8601 format. Default value is the current date."
        },
        {
          "name": "filterBy",
          "description": "array expand_less Filters by route and attachment to apply to results."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "searchBy",
          "description": "object expand_less Accepts search filter field and value to apply when searching."
        },
        {
          "name": "fieldName string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp. value string The search value to be used.",
          "description": "fieldName string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp. value string The search value to be used."
        },
        {
          "name": "fieldName",
          "description": "string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp."
        },
        {
          "name": "value",
          "description": "string The search value to be used."
        },
        {
          "name": "sortBy",
          "description": "string The field to sort results by. Must be createTime. The following values are allowed: createTime"
        },
        {
          "name": "sortOrder",
          "description": "string Sort results in order according to date. Possible values are ascending or descending, with descending being the default value. The following values are allowed: asc, desc"
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of results to return in ISO 8601 format. Default value is 7 days prior to current date."
        },
        {
          "name": "type",
          "description": "string The message queue type to return. Possible values are processing, bulk_processing with the default value being processing. The following values are allowed: processing, bulk_processing"
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The end date of results to return in ISO 8601 format. Default value is the current date."
        },
        {
          "name": "filterBy",
          "description": "array expand_less Filters by route and attachment to apply to results."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "searchBy",
          "description": "object expand_less Accepts search filter field and value to apply when searching."
        },
        {
          "name": "fieldName string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp. value string The search value to be used.",
          "description": "fieldName string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp. value string The search value to be used."
        },
        {
          "name": "fieldName",
          "description": "string The field to be searched. Possible values are ALL, fromAddress, toAddress, subject, info or remoteIp."
        },
        {
          "name": "value",
          "description": "string The search value to be used."
        },
        {
          "name": "sortBy",
          "description": "string The field to sort results by. Must be createTime. The following values are allowed: createTime"
        },
        {
          "name": "sortOrder",
          "description": "string Sort results in order according to date. Possible values are ascending or descending, with descending being the default value. The following values are allowed: asc, desc"
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The start date of results to return in ISO 8601 format. Default value is 7 days prior to current date."
        },
        {
          "name": "type",
          "description": "string The message queue type to return. Possible values are processing, bulk_processing with the default value being processing. The following values are allowed: processing, bulk_processing"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/gateway/find-processing-messages/post",
      "last_updated": "2025-12-12T14:45:02.390325+00:00"
    },
    {
      "id": "get-hold-message-list",
      "name": "Get Hold Message List",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/gateway/get-hold-message-list",
      "description": "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. 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.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less admin boolean Level of results to return. If false, only results for the currently authenticated user will be returned. If true, held messages for all recipients will be returned. The default value is false. end string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the latest message to return, in the following format, 2011-12-03T10:15:30+0000. searchBy object expand_less Object data used to filter results. fieldName string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP. value string The text used to filter results. start string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the earliest message to return, in the following format, 2011-12-03T10:15:30+0000.",
          "description": "admin boolean Level of results to return. If false, only results for the currently authenticated user will be returned. If true, held messages for all recipients will be returned. The default value is false. end string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the latest message to return, in the following format, 2011-12-03T10:15:30+0000. searchBy object expand_less Object data used to filter results. fieldName string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP. value string The text used to filter results. fieldName string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP. value string The text used to filter results. start string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the earliest message to return, in the following format, 2011-12-03T10:15:30+0000."
        },
        {
          "name": "admin",
          "description": "boolean Level of results to return. If false, only results for the currently authenticated user will be returned. If true, held messages for all recipients will be returned. The default value is false."
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the latest message to return, in the following format, 2011-12-03T10:15:30+0000."
        },
        {
          "name": "searchBy",
          "description": "object expand_less Object data used to filter results."
        },
        {
          "name": "fieldName string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP. value string The text used to filter results.",
          "description": "fieldName string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP. value string The text used to filter results."
        },
        {
          "name": "fieldName",
          "description": "string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP."
        },
        {
          "name": "value",
          "description": "string The text used to filter results."
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the earliest message to return, in the following format, 2011-12-03T10:15:30+0000."
        },
        {
          "name": "admin",
          "description": "boolean Level of results to return. If false, only results for the currently authenticated user will be returned. If true, held messages for all recipients will be returned. The default value is false."
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the latest message to return, in the following format, 2011-12-03T10:15:30+0000."
        },
        {
          "name": "searchBy",
          "description": "object expand_less Object data used to filter results."
        },
        {
          "name": "fieldName string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP. value string The text used to filter results.",
          "description": "fieldName string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP. value string The text used to filter results."
        },
        {
          "name": "fieldName",
          "description": "string Message fields to filter based on. Possible values are: all, subject, sender, recipient, reasonCode, senderIP."
        },
        {
          "name": "value",
          "description": "string The text used to filter results."
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the earliest message to return, in the following format, 2011-12-03T10:15:30+0000."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/gateway/get-hold-message-list/post",
      "last_updated": "2025-12-12T14:45:03.726932+00:00"
    },
    {
      "id": "get-hold-summary-list",
      "name": "Get Hold Summary List",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/gateway/get-hold-summary-list",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/gateway/get-hold-summary-list/post",
      "last_updated": "2025-12-12T14:45:05.024546+00:00"
    },
    {
      "id": "hold-reject",
      "name": "Hold Reject",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/gateway/hold-reject",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/gateway/hold-reject/post",
      "last_updated": "2025-12-12T14:45:06.280373+00:00"
    },
    {
      "id": "hold-release",
      "name": "Hold Release",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/gateway/hold-release",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/gateway/hold-release/post",
      "last_updated": "2025-12-12T14:45:07.569103+00:00"
    },
    {
      "id": "message-get-file",
      "name": "Message/Get File",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/gateway/message/get-file",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/gateway/message/get-file/post",
      "last_updated": "2025-12-12T14:45:08.891157+00:00"
    },
    {
      "id": "journaling-get-service",
      "name": "Journaling/Get Service",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/journaling/get-service",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/journaling/get-service/post",
      "last_updated": "2025-12-12T14:45:10.196785+00:00"
    },
    {
      "id": "managedsender-permit-or-block-sender",
      "name": "Managedsender/Permit Or Block Sender",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/managedsender/permit-or-block-sender",
      "description": null,
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  from 1 to 100 items"
        },
        {
          "name": "object expand_less action string Choose to either 'permit' (to bypass spam checks) or 'block' (to reject the email). sender (required) string The email address of sender to permit or block. to (required) string The email address of recipient to permit or block.",
          "description": "action string Choose to either 'permit' (to bypass spam checks) or 'block' (to reject the email). sender (required) string The email address of sender to permit or block. to (required) string The email address of recipient to permit or block."
        },
        {
          "name": "action",
          "description": "string Choose to either 'permit' (to bypass spam checks) or 'block' (to reject the email)."
        },
        {
          "name": "sender (required)",
          "description": "string The email address of sender to permit or block."
        },
        {
          "name": "to (required)",
          "description": "string The email address of recipient to permit or block."
        },
        {
          "name": "action",
          "description": "string Choose to either 'permit' (to bypass spam checks) or 'block' (to reject the email)."
        },
        {
          "name": "sender (required)",
          "description": "string The email address of sender to permit or block."
        },
        {
          "name": "to (required)",
          "description": "string The email address of recipient to permit or block."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/managedsender/permit-or-block-sender/post",
      "last_updated": "2025-12-12T14:45:11.476752+00:00"
    },
    {
      "id": "get-message-info",
      "name": "Get Message Info",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/message-finder/get-message-info",
      "description": "Description This API endpoint can be used to retrieve detailed information about a specific message. This API endpoint can be used to retrieve detailed information about a specific message.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less id (required) string The Mimecast ID of the message to load. This is returned by the /api/message-finder/search endpoint.",
          "description": "id (required) string The Mimecast ID of the message to load. This is returned by the /api/message-finder/search endpoint."
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast ID of the message to load. This is returned by the /api/message-finder/search endpoint."
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast ID of the message to load. This is returned by the /api/message-finder/search endpoint."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/message-finder/get-message-info/post",
      "last_updated": "2025-12-12T14:45:12.806464+00:00"
    },
    {
      "id": "search",
      "name": "Search",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/message-finder/search",
      "description": null,
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less advancedTrackAndTraceOptions object expand_less An object describing the advanced filters to use in the tracking query. from string The sending email address or domain of the messages to track. senderIP string The source IP address of messages to track. subject string The subject of the messages to track. to string The recipient email address or domain of the messages to track. url string An URL from the email content. attachments boolean If set to true then searches for emails with attachments. end string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the latest message to track, in the following format, 2011-12-03T10:15:30+0000 messageId string The internet message id of the message to track. route array An array of routes to filter by. Possible values are internal, outbound and inbound. The following values are allowed: all, internal, outbound, inbound, external searchReason string Reason for Tracking a email, used for activity tracking purposes. start string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the earliest message to track, in the following format, 2011-12-03T10:15:30+0000 status array An array of email status to filter by. Email status possible values {accepted, processing, bulk_processing, delivery, bulk_delivery, held, bounced, deferred, rejected and archived} The following values are allowed: processing, delivery, system, held, accepted, bulk_processing, bulk_delivery, bounced, deferred, rejected, archived",
          "description": "advancedTrackAndTraceOptions object expand_less An object describing the advanced filters to use in the tracking query. from string The sending email address or domain of the messages to track. senderIP string The source IP address of messages to track. subject string The subject of the messages to track. to string The recipient email address or domain of the messages to track. url string An URL from the email content. from string The sending email address or domain of the messages to track. senderIP string The source IP address of messages to track. subject string The subject of the messages to track. to string The recipient email address or domain of the messages to track. url string An URL from the email content. attachments boolean If set to true then searches for emails with attachments. end string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the latest message to track, in the following format, 2011-12-03T10:15:30+0000 messageId string The internet message id of the message to track. route array An array of routes to filter by. Possible values are internal, outbound and inbound. The following values are allowed: all, internal, outbound, inbound, external searchReason string Reason for Tracking a email, used for activity tracking purposes. start string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the earliest message to track, in the following format, 2011-12-03T10:15:30+0000 status array An array of email status to filter by. Email status possible values {accepted, processing, bulk_processing, delivery, bulk_delivery, held, bounced, deferred, rejected and archived} The following values are allowed: processing, delivery, system, held, accepted, bulk_processing, bulk_delivery, bounced, deferred, rejected, archived"
        },
        {
          "name": "advancedTrackAndTraceOptions",
          "description": "object expand_less An object describing the advanced filters to use in the tracking query."
        },
        {
          "name": "from string The sending email address or domain of the messages to track. senderIP string The source IP address of messages to track. subject string The subject of the messages to track. to string The recipient email address or domain of the messages to track. url string An URL from the email content.",
          "description": "from string The sending email address or domain of the messages to track. senderIP string The source IP address of messages to track. subject string The subject of the messages to track. to string The recipient email address or domain of the messages to track. url string An URL from the email content."
        },
        {
          "name": "from",
          "description": "string The sending email address or domain of the messages to track."
        },
        {
          "name": "senderIP",
          "description": "string The source IP address of messages to track."
        },
        {
          "name": "subject",
          "description": "string The subject of the messages to track."
        },
        {
          "name": "to",
          "description": "string The recipient email address or domain of the messages to track."
        },
        {
          "name": "url",
          "description": "string An URL from the email content."
        },
        {
          "name": "attachments",
          "description": "boolean If set to true then searches for emails with attachments."
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the latest message to track, in the following format, 2011-12-03T10:15:30+0000"
        },
        {
          "name": "messageId",
          "description": "string The internet message id of the message to track."
        },
        {
          "name": "route",
          "description": "array An array of routes to filter by. Possible values are internal, outbound and inbound. The following values are allowed: all, internal, outbound, inbound, external"
        },
        {
          "name": "searchReason",
          "description": "string Reason for Tracking a email, used for activity tracking purposes."
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the earliest message to track, in the following format, 2011-12-03T10:15:30+0000"
        },
        {
          "name": "status",
          "description": "array An array of email status to filter by. Email status possible values {accepted, processing, bulk_processing, delivery, bulk_delivery, held, bounced, deferred, rejected and archived} The following values are allowed: processing, delivery, system, held, accepted, bulk_processing, bulk_delivery, bounced, deferred, rejected, archived"
        },
        {
          "name": "advancedTrackAndTraceOptions",
          "description": "object expand_less An object describing the advanced filters to use in the tracking query."
        },
        {
          "name": "from string The sending email address or domain of the messages to track. senderIP string The source IP address of messages to track. subject string The subject of the messages to track. to string The recipient email address or domain of the messages to track. url string An URL from the email content.",
          "description": "from string The sending email address or domain of the messages to track. senderIP string The source IP address of messages to track. subject string The subject of the messages to track. to string The recipient email address or domain of the messages to track. url string An URL from the email content."
        },
        {
          "name": "from",
          "description": "string The sending email address or domain of the messages to track."
        },
        {
          "name": "senderIP",
          "description": "string The source IP address of messages to track."
        },
        {
          "name": "subject",
          "description": "string The subject of the messages to track."
        },
        {
          "name": "to",
          "description": "string The recipient email address or domain of the messages to track."
        },
        {
          "name": "url",
          "description": "string An URL from the email content."
        },
        {
          "name": "attachments",
          "description": "boolean If set to true then searches for emails with attachments."
        },
        {
          "name": "end",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the latest message to track, in the following format, 2011-12-03T10:15:30+0000"
        },
        {
          "name": "messageId",
          "description": "string The internet message id of the message to track."
        },
        {
          "name": "route",
          "description": "array An array of routes to filter by. Possible values are internal, outbound and inbound. The following values are allowed: all, internal, outbound, inbound, external"
        },
        {
          "name": "searchReason",
          "description": "string Reason for Tracking a email, used for activity tracking purposes."
        },
        {
          "name": "start",
          "description": "string (yyyy-MM-dd'T'HH:mm:ssZ) The date and time of the earliest message to track, in the following format, 2011-12-03T10:15:30+0000"
        },
        {
          "name": "status",
          "description": "array An array of email status to filter by. Email status possible values {accepted, processing, bulk_processing, delivery, bulk_delivery, held, bounced, deferred, rejected and archived} The following values are allowed: processing, delivery, system, held, accepted, bulk_processing, bulk_delivery, bounced, deferred, rejected, archived"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/message-finder/search/post",
      "last_updated": "2025-12-12T14:45:14.155095+00:00"
    },
    {
      "id": "ttp-url-decode-url",
      "name": "Ttp/Url/Decode Url",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/api/ttp/url/decode-url",
      "description": null,
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  from 1 to 25 items"
        },
        {
          "name": "object expand_less url (required) string The Mimecast encoded URL (e.g. https://protect-xx.mimecast.com/...)",
          "description": "url (required) string The Mimecast encoded URL (e.g. https://protect-xx.mimecast.com/...)"
        },
        {
          "name": "url (required)",
          "description": "string The Mimecast encoded URL (e.g. https://protect-xx.mimecast.com/...)"
        },
        {
          "name": "url (required)",
          "description": "string The Mimecast encoded URL (e.g. https://protect-xx.mimecast.com/...)"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/api/ttp/url/decode-url/post",
      "last_updated": "2025-12-12T14:45:15.479421+00:00"
    },
    {
      "id": "gateway-details",
      "name": "Gateway Details",
      "category": "Cloud Gateway",
      "method": "GET",
      "path": "/email/cloud-gateway/v1/gateway-details",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/gateway-details/get",
      "last_updated": "2025-12-12T14:45:16.743031+00:00"
    },
    {
      "id": "gateway-details",
      "name": "Gateway Details",
      "category": "Cloud Gateway",
      "method": "PATCH",
      "path": "/email/cloud-gateway/v1/gateway-details",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/gateway-details/patch",
      "last_updated": "2025-12-12T14:45:18.037193+00:00"
    },
    {
      "id": "internal-addresses-bulk-delete",
      "name": "Internal Addresses/Bulk Delete",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/email/cloud-gateway/v1/managed-senders/internal-addresses/bulk-delete",
      "description": "Description Delete all Managed Senders entries that contain internal recipients as senders on the account. Delete all Managed Senders entries that contain internal recipients as senders on the account.",
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/managed-senders/internal-addresses/bulk-delete/post",
      "last_updated": "2025-12-12T14:45:19.328061+00:00"
    },
    {
      "id": "recipients-{recipient_email}-bulk-delete",
      "name": "Recipients/{Recipient_Email}/Bulk Delete",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/email/cloud-gateway/v1/managed-senders/recipients/{recipient_email}/bulk-delete",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/managed-senders/recipients/%7Brecipient_email%7D/bulk-delete/post",
      "last_updated": "2025-12-12T14:45:20.647393+00:00"
    },
    {
      "id": "senders-bulk-delete",
      "name": "Senders/Bulk Delete",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/email/cloud-gateway/v1/managed-senders/senders/bulk-delete",
      "description": "Description Delete Managed Senders entries based on sender email addresses or sender domains in addition to optional filtering criteria (Type, Action and Trusted). Delete Managed Senders entries based on sender email addresses or sender domains in addition to optional filtering criteria (Type, Action and Trusted).",
      "parameters": [
        {
          "name": "ids",
          "description": "array Sender email addresses or sending domains. Also supports using <> for a sender email address. must contain  from 1 to 1000 items items must be unique"
        },
        {
          "name": "type",
          "description": "string Filter on auto or manual Managed Senders entries. Can only be used if action is not specified. The following values are allowed: auto, manual"
        },
        {
          "name": "action",
          "description": "string Filter on blocked or permitted Managed Senders entries. Can only be used if type is not specified. The following values are allowed: block, permit"
        },
        {
          "name": "trusted",
          "description": "boolean Filter on trusted Managed Senders entries."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/managed-senders/senders/bulk-delete/post",
      "last_updated": "2025-12-12T14:45:21.939240+00:00"
    },
    {
      "id": "outbound-ip-addresses",
      "name": "Outbound Ip Addresses",
      "category": "Cloud Gateway",
      "method": "GET",
      "path": "/email/cloud-gateway/v1/outbound-ip-addresses",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/outbound-ip-addresses/get",
      "last_updated": "2025-12-12T14:45:23.227265+00:00"
    },
    {
      "id": "outbound-ip-addresses",
      "name": "Outbound Ip Addresses",
      "category": "Cloud Gateway",
      "method": "PUT",
      "path": "/email/cloud-gateway/v1/outbound-ip-addresses",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/outbound-ip-addresses/put",
      "last_updated": "2025-12-12T14:45:24.520481+00:00"
    },
    {
      "id": "outbound-ip-addresses",
      "name": "Outbound Ip Addresses",
      "category": "Cloud Gateway",
      "method": "DELETE",
      "path": "/email/cloud-gateway/v1/outbound-ip-addresses",
      "description": "Description Deletes all outbound IP Addresses for customer\u2019s mail platform. Deletes all outbound IP Addresses for customer\u2019s mail platform.",
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/outbound-ip-addresses/delete",
      "last_updated": "2025-12-12T14:45:25.823455+00:00"
    },
    {
      "id": "statistics",
      "name": "Statistics",
      "category": "Cloud Gateway",
      "method": "GET",
      "path": "/email/cloud-gateway/v1/statistics",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/email/cloud-gateway/v1/statistics/get",
      "last_updated": "2025-12-12T14:45:27.095757+00:00"
    },
    {
      "id": "services",
      "name": "Services",
      "category": "Cloud Gateway",
      "method": "GET",
      "path": "/journaling/cloud-gateway/v1/services",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/journaling/cloud-gateway/v1/services/get",
      "last_updated": "2025-12-12T14:45:28.403031+00:00"
    },
    {
      "id": "services",
      "name": "Services",
      "category": "Cloud Gateway",
      "method": "POST",
      "path": "/journaling/cloud-gateway/v1/services",
      "description": "Description When the customer subscribes to Internal Email Protect, Continuity or Archiving we need to ensure that internal messages (that normally remain internal to the customers' email infrastructure) get copied on their infrastructure (i.e. Journaled) and this copy needs to be provided to their Mimecast account. On their Mimecast account, the message needs to be processed by a Journal Connector. Such a Journal Connector uses a specific hostname per Mimecast region. Response should have the hostname the journal items should be forwarded to. When the customer subscribes to Internal Email Protect, Continuity or Archiving we need to ensure that internal messages (that normally remain internal to the customers' email infrastructure) get copied on their infrastructure (i.e. Journaled) and this copy needs to be provided to their Mimecast account. On their Mimecast account, the message needs to be processed by a Journal Connector. Such a Journal Connector uses a specific hostname per Mimecast region. Response should have the hostname the journal items should be forwarded to. This endpoint is used to create  journaling connector. This endpoint is used to create  journaling connector.",
      "parameters": [
        {
          "name": "description (required)",
          "description": "string A description to identify the new journaling service."
        },
        {
          "name": "enabled",
          "description": "boolean Whether the new journaling service is to be enabled on creation."
        },
        {
          "name": "messageFormat",
          "description": "string Format of the journal messages to be sent - standard_eml (standard EML), exchange_env (Exchange envelope). The following values are allowed: standard_eml, exchange_env Default value \"exchange_env\""
        },
        {
          "name": "removeJournalHeaders",
          "description": "boolean If true, Mimecast will remove any X-MS-Exchange-Organization-BCC and X-MS-Exchange-CrossPremises-BCC headers that Microsoft Exchange has added. Default value false"
        },
        {
          "name": "journalNonInternalAddresses",
          "description": "boolean If true, items processed by the journal connector that do not hold an internal addresses will be archived nonetheless. Default value false"
        },
        {
          "name": "journalUnknownInternalAddresses",
          "description": "boolean If true, items processed by the journal connector that are sent from or to unknown internal addresses will be archived nonetheless. Default value false"
        },
        {
          "name": "smtpJournalingConnection (required)",
          "description": "object expand_less Details for a new SMTP journaling connection."
        },
        {
          "name": "emailAddress (required) string (email) The address of the email account created for SMTP journaling should be the same format for all journaling services example - journaling@journal.<your domain>.com. The domain varies according to the service used. ipRanges array IP address ranges that are allowed to submit messages to the new SMTP journal service. These are in addition to your customer account's authorized outbound IP addresses, which are allowed by default. Must be IPv4 in CIDR format. usesAuthentication boolean Whether to require password authentication for the new SMTP connection. Authentication requires an SMTP/Send Connector on the Exchange server. Default value false password string (password) Password for SMTP journaling. This is required if SMTP authentication is to be enabled. usesTls boolean Whether to encrypt the connection with Transport Layer Security (TLS). Default value true prefersClearText boolean Set to true for Active Directory protected journal items. Default value false extendedDeduplication boolean Only set this to true if internal messages are to be journaled via remote/local infrastructure as well as delivered via the Mimecast Gateway. If true, Mimecast will wait 10 minutes for the Gateway item after having received the internal message via the journal connector before removing duplicate messages. Not required during a Continuity Event. Default value false deliveryWaitAttempts number The number of times the system attempts to match a message before it is archived. 0 \u2264 value Default value 3 inactivityTimeout number If there is no journal activity for this many minutes, the service status changes to ERROR. 180 \u2264 value \u2264 960 Default value 180 processInitialDelay number The duration in minutes to wait before attempting to match a message to the archive. 0 \u2264 value Default value 0",
          "description": "emailAddress (required) string (email) The address of the email account created for SMTP journaling should be the same format for all journaling services example - journaling@journal.<your domain>.com. The domain varies according to the service used. ipRanges array IP address ranges that are allowed to submit messages to the new SMTP journal service. These are in addition to your customer account's authorized outbound IP addresses, which are allowed by default. Must be IPv4 in CIDR format. usesAuthentication boolean Whether to require password authentication for the new SMTP connection. Authentication requires an SMTP/Send Connector on the Exchange server. Default value false password string (password) Password for SMTP journaling. This is required if SMTP authentication is to be enabled. usesTls boolean Whether to encrypt the connection with Transport Layer Security (TLS). Default value true prefersClearText boolean Set to true for Active Directory protected journal items. Default value false extendedDeduplication boolean Only set this to true if internal messages are to be journaled via remote/local infrastructure as well as delivered via the Mimecast Gateway. If true, Mimecast will wait 10 minutes for the Gateway item after having received the internal message via the journal connector before removing duplicate messages. Not required during a Continuity Event. Default value false deliveryWaitAttempts number The number of times the system attempts to match a message before it is archived. 0 \u2264 value Default value 3 inactivityTimeout number If there is no journal activity for this many minutes, the service status changes to ERROR. 180 \u2264 value \u2264 960 Default value 180 processInitialDelay number The duration in minutes to wait before attempting to match a message to the archive. 0 \u2264 value Default value 0"
        },
        {
          "name": "emailAddress (required)",
          "description": "string (email) The address of the email account created for SMTP journaling should be the same format for all journaling services example - journaling@journal.<your domain>.com. The domain varies according to the service used."
        },
        {
          "name": "ipRanges",
          "description": "array IP address ranges that are allowed to submit messages to the new SMTP journal service. These are in addition to your customer account's authorized outbound IP addresses, which are allowed by default. Must be IPv4 in CIDR format."
        },
        {
          "name": "usesAuthentication",
          "description": "boolean Whether to require password authentication for the new SMTP connection. Authentication requires an SMTP/Send Connector on the Exchange server. Default value false"
        },
        {
          "name": "password",
          "description": "string (password) Password for SMTP journaling. This is required if SMTP authentication is to be enabled."
        },
        {
          "name": "usesTls",
          "description": "boolean Whether to encrypt the connection with Transport Layer Security (TLS). Default value true"
        },
        {
          "name": "prefersClearText",
          "description": "boolean Set to true for Active Directory protected journal items. Default value false"
        },
        {
          "name": "extendedDeduplication",
          "description": "boolean Only set this to true if internal messages are to be journaled via remote/local infrastructure as well as delivered via the Mimecast Gateway. If true, Mimecast will wait 10 minutes for the Gateway item after having received the internal message via the journal connector before removing duplicate messages. Not required during a Continuity Event. Default value false"
        },
        {
          "name": "deliveryWaitAttempts",
          "description": "number The number of times the system attempts to match a message before it is archived. 0 \u2264 value Default value 3"
        },
        {
          "name": "inactivityTimeout",
          "description": "number If there is no journal activity for this many minutes, the service status changes to ERROR. 180 \u2264 value \u2264 960 Default value 180"
        },
        {
          "name": "processInitialDelay",
          "description": "number The duration in minutes to wait before attempting to match a message to the archive. 0 \u2264 value Default value 0"
        },
        {
          "name": "pop3JournalingConnection (required)",
          "description": "object expand_less Details for a new POP3 journaling connection."
        },
        {
          "name": "emailAddress (required) string (email) Email address of the journal mailbox. This must be different for each journaling service. mailbox (required) string The username to use when logging into the journaling mailbox. password (required) string (password) The password to use when logging into the journal mailbox. host (required) string Hostname or IP address where the journaling mailbox is housed.  Your firewall must be configured to allow inbound POP3/POP3S traffic from Mimecast to this address. port number The TCP/IP port to use for journal message transfer. Standard value is 995 (POP3S) or 110 (POP3). 1 \u2264 value \u2264 65535 Default value 995 usesPOP3S boolean Whether the connection should be encrypted and journal messages pulled only using POP3S. Default value true encryptionIsRelaxed boolean Relaxed encryption permits encryption self-signed certificates and other valid certificates that may not have a complete trust chain. Default value false detailedLoggingIsEnabled boolean Enabling helps Mimecast Support to troubleshoot a failed journaling inbox. Default value false",
          "description": "emailAddress (required) string (email) Email address of the journal mailbox. This must be different for each journaling service. mailbox (required) string The username to use when logging into the journaling mailbox. password (required) string (password) The password to use when logging into the journal mailbox. host (required) string Hostname or IP address where the journaling mailbox is housed.  Your firewall must be configured to allow inbound POP3/POP3S traffic from Mimecast to this address. port number The TCP/IP port to use for journal message transfer. Standard value is 995 (POP3S) or 110 (POP3). 1 \u2264 value \u2264 65535 Default value 995 usesPOP3S boolean Whether the connection should be encrypted and journal messages pulled only using POP3S. Default value true encryptionIsRelaxed boolean Relaxed encryption permits encryption self-signed certificates and other valid certificates that may not have a complete trust chain. Default value false detailedLoggingIsEnabled boolean Enabling helps Mimecast Support to troubleshoot a failed journaling inbox. Default value false"
        },
        {
          "name": "emailAddress (required)",
          "description": "string (email) Email address of the journal mailbox. This must be different for each journaling service."
        },
        {
          "name": "mailbox (required)",
          "description": "string The username to use when logging into the journaling mailbox."
        },
        {
          "name": "password (required)",
          "description": "string (password) The password to use when logging into the journal mailbox."
        },
        {
          "name": "host (required)",
          "description": "string Hostname or IP address where the journaling mailbox is housed.  Your firewall must be configured to allow inbound POP3/POP3S traffic from Mimecast to this address."
        },
        {
          "name": "port",
          "description": "number The TCP/IP port to use for journal message transfer. Standard value is 995 (POP3S) or 110 (POP3). 1 \u2264 value \u2264 65535 Default value 995"
        },
        {
          "name": "usesPOP3S",
          "description": "boolean Whether the connection should be encrypted and journal messages pulled only using POP3S. Default value true"
        },
        {
          "name": "encryptionIsRelaxed",
          "description": "boolean Relaxed encryption permits encryption self-signed certificates and other valid certificates that may not have a complete trust chain. Default value false"
        },
        {
          "name": "detailedLoggingIsEnabled",
          "description": "boolean Enabling helps Mimecast Support to troubleshoot a failed journaling inbox. Default value false"
        },
        {
          "name": "emailAddress (required)",
          "description": "string (email) The address of the email account created for SMTP journaling should be the same format for all journaling services example - journaling@journal.<your domain>.com. The domain varies according to the service used."
        },
        {
          "name": "ipRanges",
          "description": "array IP address ranges that are allowed to submit messages to the new SMTP journal service. These are in addition to your customer account's authorized outbound IP addresses, which are allowed by default. Must be IPv4 in CIDR format."
        },
        {
          "name": "usesAuthentication",
          "description": "boolean Whether to require password authentication for the new SMTP connection. Authentication requires an SMTP/Send Connector on the Exchange server. Default value false"
        },
        {
          "name": "password",
          "description": "string (password) Password for SMTP journaling. This is required if SMTP authentication is to be enabled."
        },
        {
          "name": "usesTls",
          "description": "boolean Whether to encrypt the connection with Transport Layer Security (TLS). Default value true"
        },
        {
          "name": "prefersClearText",
          "description": "boolean Set to true for Active Directory protected journal items. Default value false"
        },
        {
          "name": "extendedDeduplication",
          "description": "boolean Only set this to true if internal messages are to be journaled via remote/local infrastructure as well as delivered via the Mimecast Gateway. If true, Mimecast will wait 10 minutes for the Gateway item after having received the internal message via the journal connector before removing duplicate messages. Not required during a Continuity Event. Default value false"
        },
        {
          "name": "deliveryWaitAttempts",
          "description": "number The number of times the system attempts to match a message before it is archived. 0 \u2264 value Default value 3"
        },
        {
          "name": "inactivityTimeout",
          "description": "number If there is no journal activity for this many minutes, the service status changes to ERROR. 180 \u2264 value \u2264 960 Default value 180"
        },
        {
          "name": "processInitialDelay",
          "description": "number The duration in minutes to wait before attempting to match a message to the archive. 0 \u2264 value Default value 0"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/journaling/cloud-gateway/v1/services/post",
      "last_updated": "2025-12-12T14:45:29.691581+00:00"
    },
    {
      "id": "{journaling_id}",
      "name": "{Journaling_Id}",
      "category": "Cloud Gateway",
      "method": "GET",
      "path": "/journaling/cloud-gateway/v1/services/{journaling_id}",
      "description": "Description This endpoint returns journaling connector, their configuration and current status specified with the journaling id in the endpoint. This endpoint returns journaling connector, their configuration and current status specified with the journaling id in the endpoint.",
      "parameters": [
        {
          "name": "journaling_id (required)",
          "description": "integer ID of the journaling service."
        },
        {
          "name": "id",
          "description": "string ID of the journaling service."
        },
        {
          "name": "description",
          "description": "string The customer-provided description of the journaling service."
        },
        {
          "name": "messageFormat",
          "description": "string Journal message format - standard_eml (standard EML), exchange_env (Exchange envelope). The following values are allowed: standard_eml, exchange_env"
        },
        {
          "name": "queueSize",
          "description": "number The number of items in the journaling queue."
        },
        {
          "name": "removeJournalHeaders",
          "description": "boolean If true, Mimecast will remove any X-MS-Exchange-Organization-BCC and X-MS-Exchange-CrossPremises-BCC headers that Microsoft Exchange has added."
        },
        {
          "name": "transferProtocol",
          "description": "string The email transfer protocol for the journaling service - pop3 or smtp. The following values are allowed: pop3, smtp Default value \"smtp\""
        },
        {
          "name": "enabled",
          "description": "boolean Whether the journaling service is currently enabled."
        },
        {
          "name": "journalNonInternalAddresses",
          "description": "boolean If true, items processed by the journal connector that do not hold an internal address are archived nonetheless."
        },
        {
          "name": "journalUnknownInternalAddresses",
          "description": "boolean If true, items processed by the journal connector that are sent from or to unknown internal addresses are archived nonetheless."
        },
        {
          "name": "pop3JournalingConnection",
          "description": "object expand_less Status information about the journaling connection."
        },
        {
          "name": "emailAddress string (email) Email address of the journal mailbox. This must be different for each journaling service. mailbox string The username to use when logging into the journaling mailbox. password string (password) The password to use when logging into the journal mailbox. host string Hostname or IP address where the journaling mailbox is housed.  Your firewall must be configured to allow inbound POP3/POP3S traffic from Mimecast to this address. port number The TCP/IP port to use for journal message transfer. Standard value is 995 (POP3S) or 110 (POP3). 1 \u2264 value \u2264 65535 Default value 995 usesPOP3S boolean Whether the connection should be encrypted and journal messages pulled only using POP3S. Default value true encryptionIsRelaxed boolean Relaxed encryption permits encryption self-signed certificates and other valid certificates that may not have a complete trust chain. Default = false. Default value false detailedLoggingIsEnabled boolean Enabling helps Mimecast Support to troubleshoot a failed journaling inbox. Default value false",
          "description": "emailAddress string (email) Email address of the journal mailbox. This must be different for each journaling service. mailbox string The username to use when logging into the journaling mailbox. password string (password) The password to use when logging into the journal mailbox. host string Hostname or IP address where the journaling mailbox is housed.  Your firewall must be configured to allow inbound POP3/POP3S traffic from Mimecast to this address. port number The TCP/IP port to use for journal message transfer. Standard value is 995 (POP3S) or 110 (POP3). 1 \u2264 value \u2264 65535 Default value 995 usesPOP3S boolean Whether the connection should be encrypted and journal messages pulled only using POP3S. Default value true encryptionIsRelaxed boolean Relaxed encryption permits encryption self-signed certificates and other valid certificates that may not have a complete trust chain. Default = false. Default value false detailedLoggingIsEnabled boolean Enabling helps Mimecast Support to troubleshoot a failed journaling inbox. Default value false"
        },
        {
          "name": "emailAddress",
          "description": "string (email) Email address of the journal mailbox. This must be different for each journaling service."
        },
        {
          "name": "mailbox",
          "description": "string The username to use when logging into the journaling mailbox."
        },
        {
          "name": "password",
          "description": "string (password) The password to use when logging into the journal mailbox."
        },
        {
          "name": "host",
          "description": "string Hostname or IP address where the journaling mailbox is housed.  Your firewall must be configured to allow inbound POP3/POP3S traffic from Mimecast to this address."
        },
        {
          "name": "port",
          "description": "number The TCP/IP port to use for journal message transfer. Standard value is 995 (POP3S) or 110 (POP3). 1 \u2264 value \u2264 65535 Default value 995"
        },
        {
          "name": "usesPOP3S",
          "description": "boolean Whether the connection should be encrypted and journal messages pulled only using POP3S. Default value true"
        },
        {
          "name": "encryptionIsRelaxed",
          "description": "boolean Relaxed encryption permits encryption self-signed certificates and other valid certificates that may not have a complete trust chain. Default = false. Default value false"
        },
        {
          "name": "detailedLoggingIsEnabled",
          "description": "boolean Enabling helps Mimecast Support to troubleshoot a failed journaling inbox. Default value false"
        },
        {
          "name": "smtpJournalingConnection",
          "description": "object expand_less Details specific to an SMTP journaling connection."
        },
        {
          "name": "emailAddress string (email) The address of the email account created for SMTP journaling. This must be different for each journaling service. ipRanges array IP address ranges that are allowed to submit messages to the new SMTP journal service. These are in addition to your customer account's authorized outbound IP addresses, which are allowed by default. Must be IPv4 in CIDR format. usesAuthentication boolean Whether to require password authentication for the new SMTP connection. Authentication requires an SMTP/Send Connector on the Exchange server. Default value false password string (password) Password for SMTP journaling. This is required if SMTP authentication is to be enabled. usesTls boolean Whether to encrypt the connection with Transport Layer Security (TLS). Default value true prefersClearText boolean Set to true for Active Directory protected journal items. Default value false extendedDeduplication boolean Only set this to true if internal messages are to be journaled via remote/local infrastructure as well as delivered via the Mimecast Gateway. If true, Mimecast will wait 10 minutes for the Gateway item after having received the internal message via the journal connector before removing duplicate messages. Not required during a Continuity Event. Default value false deliveryWaitAttempts number The number of times the system attempts to match a message before it is archived. 0 \u2264 value Default value 3 inactivityTimeout number If there is no journal activity for this many minutes, the service status changes to ERROR. 180 \u2264 value \u2264 960 Default value 180 processInitialDelay number The duration in minutes to wait before attempting to match a message to the archive. 0 \u2264 value Default value 0 hostnames array The Journal Send Connector hostnames. These are not user configurable.",
          "description": "emailAddress string (email) The address of the email account created for SMTP journaling. This must be different for each journaling service. ipRanges array IP address ranges that are allowed to submit messages to the new SMTP journal service. These are in addition to your customer account's authorized outbound IP addresses, which are allowed by default. Must be IPv4 in CIDR format. usesAuthentication boolean Whether to require password authentication for the new SMTP connection. Authentication requires an SMTP/Send Connector on the Exchange server. Default value false password string (password) Password for SMTP journaling. This is required if SMTP authentication is to be enabled. usesTls boolean Whether to encrypt the connection with Transport Layer Security (TLS). Default value true prefersClearText boolean Set to true for Active Directory protected journal items. Default value false extendedDeduplication boolean Only set this to true if internal messages are to be journaled via remote/local infrastructure as well as delivered via the Mimecast Gateway. If true, Mimecast will wait 10 minutes for the Gateway item after having received the internal message via the journal connector before removing duplicate messages. Not required during a Continuity Event. Default value false deliveryWaitAttempts number The number of times the system attempts to match a message before it is archived. 0 \u2264 value Default value 3 inactivityTimeout number If there is no journal activity for this many minutes, the service status changes to ERROR. 180 \u2264 value \u2264 960 Default value 180 processInitialDelay number The duration in minutes to wait before attempting to match a message to the archive. 0 \u2264 value Default value 0 hostnames array The Journal Send Connector hostnames. These are not user configurable."
        },
        {
          "name": "emailAddress",
          "description": "string (email) The address of the email account created for SMTP journaling. This must be different for each journaling service."
        },
        {
          "name": "ipRanges",
          "description": "array IP address ranges that are allowed to submit messages to the new SMTP journal service. These are in addition to your customer account's authorized outbound IP addresses, which are allowed by default. Must be IPv4 in CIDR format."
        },
        {
          "name": "usesAuthentication",
          "description": "boolean Whether to require password authentication for the new SMTP connection. Authentication requires an SMTP/Send Connector on the Exchange server. Default value false"
        },
        {
          "name": "password",
          "description": "string (password) Password for SMTP journaling. This is required if SMTP authentication is to be enabled."
        },
        {
          "name": "usesTls",
          "description": "boolean Whether to encrypt the connection with Transport Layer Security (TLS). Default value true"
        },
        {
          "name": "prefersClearText",
          "description": "boolean Set to true for Active Directory protected journal items. Default value false"
        },
        {
          "name": "extendedDeduplication",
          "description": "boolean Only set this to true if internal messages are to be journaled via remote/local infrastructure as well as delivered via the Mimecast Gateway. If true, Mimecast will wait 10 minutes for the Gateway item after having received the internal message via the journal connector before removing duplicate messages. Not required during a Continuity Event. Default value false"
        },
        {
          "name": "deliveryWaitAttempts",
          "description": "number The number of times the system attempts to match a message before it is archived. 0 \u2264 value Default value 3"
        },
        {
          "name": "inactivityTimeout",
          "description": "number If there is no journal activity for this many minutes, the service status changes to ERROR. 180 \u2264 value \u2264 960 Default value 180"
        },
        {
          "name": "processInitialDelay",
          "description": "number The duration in minutes to wait before attempting to match a message to the archive. 0 \u2264 value Default value 0"
        },
        {
          "name": "hostnames",
          "description": "array The Journal Send Connector hostnames. These are not user configurable."
        },
        {
          "name": "statusInfo",
          "description": "object expand_less"
        },
        {
          "name": "lastReceivedDateTime string (date-time) Date and time when the last journaling message was received. status string Status of the journaling service - ok, not_active, error. The following values are allowed: ok, not_active, error",
          "description": "lastReceivedDateTime string (date-time) Date and time when the last journaling message was received. status string Status of the journaling service - ok, not_active, error. The following values are allowed: ok, not_active, error"
        },
        {
          "name": "lastReceivedDateTime",
          "description": "string (date-time) Date and time when the last journaling message was received."
        },
        {
          "name": "status",
          "description": "string Status of the journaling service - ok, not_active, error. The following values are allowed: ok, not_active, error"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/journaling/cloud-gateway/v1/services/%7Bjournaling_id%7D/get",
      "last_updated": "2025-12-12T14:45:30.996894+00:00"
    },
    {
      "id": "{journaling_id}",
      "name": "{Journaling_Id}",
      "category": "Cloud Gateway",
      "method": "PATCH",
      "path": "/journaling/cloud-gateway/v1/services/{journaling_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/journaling/cloud-gateway/v1/services/%7Bjournaling_id%7D/patch",
      "last_updated": "2025-12-12T14:45:32.287265+00:00"
    },
    {
      "id": "{journaling_id}",
      "name": "{Journaling_Id}",
      "category": "Cloud Gateway",
      "method": "DELETE",
      "path": "/journaling/cloud-gateway/v1/services/{journaling_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/cloudgateway/1/routes/journaling/cloud-gateway/v1/services/%7Bjournaling_id%7D/delete",
      "last_updated": "2025-12-12T14:45:33.597426+00:00"
    },
    {
      "id": "emergency-contact",
      "name": "Emergency Contact",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/account/cloud-gateway/v1/emergency-contact",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/account/cloud-gateway/v1/emergency-contact/get",
      "last_updated": "2025-12-12T14:45:51.136053+00:00"
    },
    {
      "id": "emergency-contact",
      "name": "Emergency Contact",
      "category": "Email Security Onboarding",
      "method": "PUT",
      "path": "/account/cloud-gateway/v1/emergency-contact",
      "description": "Description Creates an Emergency Contact for the account. Creates an Emergency Contact for the account.",
      "parameters": [
        {
          "name": "contactName (required)",
          "description": "string Name of the emergency contact. length  \u2264 60"
        },
        {
          "name": "contactEmailAddress (required)",
          "description": "string Email address of the emergency contact."
        },
        {
          "name": "mobilePhone (required)",
          "description": "string Mobile number of emergency contact in international format (with +). Please see Country Calling Codes ."
        },
        {
          "name": "telephone",
          "description": "string Telephone of emergency contact in international format (with +). Please see Country Calling Codes ."
        },
        {
          "name": "alternateEmailAddresses",
          "description": "array Alternate Email address for the emergency contact. must contain at most 4 items"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/account/cloud-gateway/v1/emergency-contact/put",
      "last_updated": "2025-12-12T14:45:52.463619+00:00"
    },
    {
      "id": "emergency-contact",
      "name": "Emergency Contact",
      "category": "Email Security Onboarding",
      "method": "PATCH",
      "path": "/account/cloud-gateway/v1/emergency-contact",
      "description": "Description Updates the Emergency Contact information for the account. Updates the Emergency Contact information for the account.",
      "parameters": [
        {
          "name": "contactName",
          "description": "string Name of the emergency contact. length  \u2264 60"
        },
        {
          "name": "contactEmailAddress",
          "description": "string Email address of the emergency contact."
        },
        {
          "name": "mobilePhone",
          "description": "string Mobile number of emergency contact in international format (with +). Please see Country Calling Codes ."
        },
        {
          "name": "telephone",
          "description": "string Telephone of emergency contact in international format (with +). Please see Country Calling Codes ."
        },
        {
          "name": "alternateEmailAddresses",
          "description": "array Alternate Email address for the emergency contact. must contain at most 4 items"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/account/cloud-gateway/v1/emergency-contact/patch",
      "last_updated": "2025-12-12T14:45:53.780250+00:00"
    },
    {
      "id": "connectors",
      "name": "Connectors",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/connector/cloud-gateway/v1/connectors",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/connector/cloud-gateway/v1/connectors/get",
      "last_updated": "2025-12-12T14:45:55.047082+00:00"
    },
    {
      "id": "connectors",
      "name": "Connectors",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/connector/cloud-gateway/v1/connectors",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/connector/cloud-gateway/v1/connectors/post",
      "last_updated": "2025-12-12T14:45:56.334161+00:00"
    },
    {
      "id": "{connector_id}",
      "name": "{Connector_Id}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/connector/cloud-gateway/v1/connectors/{connector_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/connector/cloud-gateway/v1/connectors/%7Bconnector_id%7D/get",
      "last_updated": "2025-12-12T14:45:57.622766+00:00"
    },
    {
      "id": "{connector_id}",
      "name": "{Connector_Id}",
      "category": "Email Security Onboarding",
      "method": "PATCH",
      "path": "/connector/cloud-gateway/v1/connectors/{connector_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/connector/cloud-gateway/v1/connectors/%7Bconnector_id%7D/patch",
      "last_updated": "2025-12-12T14:45:58.895691+00:00"
    },
    {
      "id": "{connector_id}",
      "name": "{Connector_Id}",
      "category": "Email Security Onboarding",
      "method": "DELETE",
      "path": "/connector/cloud-gateway/v1/connectors/{connector_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/connector/cloud-gateway/v1/connectors/%7Bconnector_id%7D/delete",
      "last_updated": "2025-12-12T14:46:00.171274+00:00"
    },
    {
      "id": "groups",
      "name": "Groups",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/groups",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/groups/get",
      "last_updated": "2025-12-12T14:46:01.439698+00:00"
    },
    {
      "id": "{group_id}",
      "name": "{Group_Id}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/groups/{group_id}",
      "description": "Description This endpoint can be used to get a profile group from a tenant. This endpoint can be used to get a profile group from a tenant.",
      "parameters": [
        {
          "name": "group_id (required)",
          "description": "string Group ID."
        },
        {
          "name": "description",
          "description": "string Group description."
        },
        {
          "name": "source",
          "description": "string Group source. The following values are allowed: cloud, ldap"
        },
        {
          "name": "parentId",
          "description": "string Parent group ID."
        },
        {
          "name": "userCount",
          "description": "number Number of users belonging to group."
        },
        {
          "name": "groupCount",
          "description": "number Number of sub-groups belonging to group."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/groups/%7Bgroup_id%7D/get",
      "last_updated": "2025-12-12T14:46:02.769044+00:00"
    },
    {
      "id": "members",
      "name": "Members",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/groups/{group_id}/members",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/groups/%7Bgroup_id%7D/members/get",
      "last_updated": "2025-12-12T14:46:04.072903+00:00"
    },
    {
      "id": "members",
      "name": "Members",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/groups/{group_id}/members",
      "description": "Description This endpoint can be used to add user email addresses or domains to a profile group. This endpoint can be used to add user email addresses or domains to a profile group.",
      "parameters": [
        {
          "name": "group_id (required)",
          "description": "string Group ID."
        },
        {
          "name": "groupMembers (required)",
          "description": "array expand_less The group members to add."
        },
        {
          "name": "object expand_less emailAddress string The email address of the user. domain string Domain name. note string Notes. length  \u2264 100",
          "description": "emailAddress string The email address of the user. domain string Domain name. note string Notes. length  \u2264 100"
        },
        {
          "name": "emailAddress",
          "description": "string The email address of the user."
        },
        {
          "name": "domain",
          "description": "string Domain name."
        },
        {
          "name": "note",
          "description": "string Notes. length  \u2264 100"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/groups/%7Bgroup_id%7D/members/post",
      "last_updated": "2025-12-12T14:46:05.483595+00:00"
    },
    {
      "id": "remove-members",
      "name": "Remove Members",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/groups/{group_id}/remove-members",
      "description": "Description This endpoint can be used to remove group members from Mimecast Profile groups. This endpoint can be used to remove group members from Mimecast Profile groups.",
      "parameters": [
        {
          "name": "group_id (required)",
          "description": "string Group ID."
        },
        {
          "name": "groupMembers (required)",
          "description": "array expand_less The group members to remove."
        },
        {
          "name": "object expand_less emailAddress string The email address of the user. domain string Domain name.",
          "description": "emailAddress string The email address of the user. domain string Domain name."
        },
        {
          "name": "emailAddress",
          "description": "string The email address of the user."
        },
        {
          "name": "domain",
          "description": "string Domain name."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/groups/%7Bgroup_id%7D/remove-members/post",
      "last_updated": "2025-12-12T14:46:06.791618+00:00"
    },
    {
      "id": "integrations",
      "name": "Integrations",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/integrations",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/get",
      "last_updated": "2025-12-12T14:46:08.056727+00:00"
    },
    {
      "id": "active-directory",
      "name": "Active Directory",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/post",
      "last_updated": "2025-12-12T14:46:09.341734+00:00"
    },
    {
      "id": "{integration_id}",
      "name": "{Integration_Id}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}",
      "description": "Description Gets an Active Directory directory integration. Gets an Active Directory directory integration.",
      "parameters": [
        {
          "name": "integration_id (required)",
          "description": "string ID of the Active Directory integration to get."
        },
        {
          "name": "enabled",
          "description": "boolean Whether integration is enabled or disabled."
        },
        {
          "name": "description",
          "description": "string The description of the integration. length  \u2264 120"
        },
        {
          "name": "info",
          "description": "string Additional info about the active directory integration. length  \u2264 240"
        },
        {
          "name": "hostname",
          "description": "string Server name - IP address or host/domain name."
        },
        {
          "name": "alternateHostname",
          "description": "string Alternate server name - IP address or host/domain name."
        },
        {
          "name": "port",
          "description": "integer The port number the integration should use to communicate on. 1 \u2264 value \u2264 65535"
        },
        {
          "name": "userDn",
          "description": "string User distinguished name e.g. CN=User, CN=Users, DC=companyname, DC=com."
        },
        {
          "name": "rootDn",
          "description": "string Root distinguished name - CN=User, CN=Users, DC=companyname, DC=com."
        },
        {
          "name": "encryptionMode",
          "description": "string The mode of encryption set on the connector - none, strict, relaxed. The following values are allowed: relaxed, strict, none"
        },
        {
          "name": "status",
          "description": "string Status of the integration - ok, not_active, error. The following values are allowed: ok, not_active, error"
        },
        {
          "name": "lastSyncDateTime",
          "description": "string (date-time) Time of the last sync made using this connector. Format yyyy-MM-dd'T'HH:mm:ssZ."
        },
        {
          "name": "syncRunning",
          "description": "boolean Whether sync is running for this integration."
        },
        {
          "name": "domains",
          "description": "array List the domains the Directory Connector will synchronize details with (Optional)."
        },
        {
          "name": "acknowledgeDisabledAccounts",
          "description": "boolean Acknowledge disabled accounts in AD."
        },
        {
          "name": "maxUnlink",
          "description": "integer Max unlink count."
        },
        {
          "name": "syncContacts",
          "description": "boolean Sync contacts."
        },
        {
          "name": "deleteUsers",
          "description": "boolean Delete users."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/get",
      "last_updated": "2025-12-12T14:46:10.639420+00:00"
    },
    {
      "id": "{integration_id}",
      "name": "{Integration_Id}",
      "category": "Email Security Onboarding",
      "method": "PATCH",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/patch",
      "last_updated": "2025-12-12T14:46:12.127382+00:00"
    },
    {
      "id": "{integration_id}",
      "name": "{Integration_Id}",
      "category": "Email Security Onboarding",
      "method": "DELETE",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/delete",
      "last_updated": "2025-12-12T14:46:13.434596+00:00"
    },
    {
      "id": "test-authentication",
      "name": "Test Authentication",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-authentication",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-authentication/post",
      "last_updated": "2025-12-12T14:46:14.694063+00:00"
    },
    {
      "id": "test-certificates",
      "name": "Test Certificates",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-certificates",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-certificates/post",
      "last_updated": "2025-12-12T14:46:16.045948+00:00"
    },
    {
      "id": "test-connectivity",
      "name": "Test Connectivity",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-connectivity",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-connectivity/post",
      "last_updated": "2025-12-12T14:46:17.366778+00:00"
    },
    {
      "id": "test-egress-connectivity",
      "name": "Test Egress Connectivity",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-egress-connectivity",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-egress-connectivity/post",
      "last_updated": "2025-12-12T14:46:18.645048+00:00"
    },
    {
      "id": "test-email",
      "name": "Test Email",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-email",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-email/post",
      "last_updated": "2025-12-12T14:46:19.928023+00:00"
    },
    {
      "id": "test-validation",
      "name": "Test Validation",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-validation",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-validation/post",
      "last_updated": "2025-12-12T14:46:21.203651+00:00"
    },
    {
      "id": "google",
      "name": "Google",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/google",
      "description": "Description Creates a new directory integration for Google. Creates a new directory integration for Google.",
      "parameters": [
        {
          "name": "enabled",
          "description": "boolean Whether integration is enabled or disabled. Default value true"
        },
        {
          "name": "description",
          "description": "string Integration description."
        },
        {
          "name": "info",
          "description": "string Additional info about the integration."
        },
        {
          "name": "domains",
          "description": "array List of domains the Directory Connector will synchronize with."
        },
        {
          "name": "maxUnlink",
          "description": "string Max unlink count. The following values are allowed: 0, 10, 20, 50, 100, 300, 500, 1,000, 2,000, 5,000, 10,000, 50,000, 100,000, unlimited Default value \"10\""
        },
        {
          "name": "deleteUsers",
          "description": "boolean Whether the connector should delete users. Default value false"
        },
        {
          "name": "acknowledgeDisabledAccounts",
          "description": "boolean Acknowledge disabled accounts in integration. Default value false"
        },
        {
          "name": "user",
          "description": "string Email address of the Google user account to be used by the service account."
        },
        {
          "name": "key",
          "description": "string (password) JSON provided when creating a Google service account."
        },
        {
          "name": "id",
          "description": "string ID of entity."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/google/post",
      "last_updated": "2025-12-12T14:46:22.532965+00:00"
    },
    {
      "id": "test-authorisation",
      "name": "Test Authorisation",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/google/{integration_id}/test-authorisation",
      "description": "Description Tests a Google directory has the correct authorised permission set. Tests a Google directory has the correct authorised permission set.",
      "parameters": [
        {
          "name": "integration_id (required)",
          "description": "string ID of the Google directory integration to test."
        },
        {
          "name": "success",
          "description": "boolean Indicates whether the test is successful."
        },
        {
          "name": "permissions",
          "description": "array"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/google/%7Bintegration_id%7D/test-authorisation/post",
      "last_updated": "2025-12-12T14:46:28.988568+00:00"
    },
    {
      "id": "m365",
      "name": "M365",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/m365",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/m365/post",
      "last_updated": "2025-12-12T14:46:32.860635+00:00"
    },
    {
      "id": "test-connector",
      "name": "Test Connector",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/m365/{integration_id}/test-connector",
      "description": "Description Tests the connector associated to a M365 directory authorisation. Tests the connector associated to a M365 directory authorisation.",
      "parameters": [
        {
          "name": "integration_id (required)",
          "description": "string ID of the Microsoft 365 integration to test."
        },
        {
          "name": "success",
          "description": "boolean Indicates if the connector associated to the directory successfully connected."
        },
        {
          "name": "status",
          "description": "string The status of the connector the directory is associated to."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/m365/%7Bintegration_id%7D/test-connector/post",
      "last_updated": "2025-12-12T14:46:41.941693+00:00"
    },
    {
      "id": "sync-requests",
      "name": "Sync Requests",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/sync-requests",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/directory/cloud-gateway/v1/integrations/sync-requests/post",
      "last_updated": "2025-12-12T14:46:44.525738+00:00"
    },
    {
      "id": "external-domains",
      "name": "External Domains",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/external-domains",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/external-domains/get",
      "last_updated": "2025-12-12T14:46:45.829979+00:00"
    },
    {
      "id": "external-domains-{domain_id}",
      "name": "External Domains/{Domain_Id}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/external-domains/{domain_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/external-domains/%7Bdomain_id%7D/get",
      "last_updated": "2025-12-12T14:46:47.099720+00:00"
    },
    {
      "id": "internal-domains",
      "name": "Internal Domains",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/internal-domains",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/internal-domains/get",
      "last_updated": "2025-12-12T14:46:48.371374+00:00"
    },
    {
      "id": "{domain_id}",
      "name": "{Domain_Id}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/internal-domains/{domain_id}",
      "description": "Description Gets a single internal domain. Gets a single internal domain.",
      "parameters": [
        {
          "name": "domain_id (required)",
          "description": "string Domain ID."
        },
        {
          "name": "id",
          "description": "string Domain ID."
        },
        {
          "name": "domain",
          "description": "string Domain name."
        },
        {
          "name": "local",
          "description": "boolean Whether the domain is local."
        },
        {
          "name": "sendOnly",
          "description": "boolean Whether the domain is send-only."
        },
        {
          "name": "inboundType",
          "description": "string Inbound type - any (Accept Any Address), smtp (SMTP Call Forward), ldap (LDAP Users Only), known (Known Recipients Only), backup_mx (Act as backup MX), smtp_null (SMTP Call forward with null sender (<>) to check recipient addresses). The following values are allowed: any, smtp, ldap, known, backup_mx, smtp_null"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/internal-domains/%7Bdomain_id%7D/get",
      "last_updated": "2025-12-12T14:46:49.659898+00:00"
    },
    {
      "id": "{domain_id}",
      "name": "{Domain_Id}",
      "category": "Email Security Onboarding",
      "method": "PATCH",
      "path": "/domain/cloud-gateway/v1/internal-domains/{domain_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/internal-domains/%7Bdomain_id%7D/patch",
      "last_updated": "2025-12-12T14:46:50.940680+00:00"
    },
    {
      "id": "{domain_id}-dns-records-{record_type}",
      "name": "{Domain_Id}/Dns Records/{Record_Type}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/internal-domains/{domain_id}/dns-records/{record_type}",
      "description": "Description Returns the DNS record lookup for internal domain. Returns the DNS record lookup for internal domain.",
      "parameters": [
        {
          "name": "domain_id (required)",
          "description": "string Domain ID."
        },
        {
          "name": "record_type (required)",
          "description": "string The following values are allowed: a, aaaa, cname, mx, ns, txt Record type to lookup."
        },
        {
          "name": "domain",
          "description": "string The domain name."
        },
        {
          "name": "recordType",
          "description": "string DNS record type. The following values are allowed: a, aaaa, cname, mx, ns, txt"
        },
        {
          "name": "records",
          "description": "array Records for given domain name and type."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/internal-domains/%7Bdomain_id%7D/dns-records/%7Brecord_type%7D/get",
      "last_updated": "2025-12-12T14:46:52.265478+00:00"
    },
    {
      "id": "verify",
      "name": "Verify",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/domain/cloud-gateway/v1/internal-domains/verify",
      "description": "Description The Api endpoint checks all the internal domains to ensure the customer has updated their MX records correctly. The Api endpoint checks all the internal domains to ensure the customer has updated their MX records correctly.",
      "parameters": [
        {
          "name": "domains",
          "description": "array List of domains to verify. must contain  from 1 to 50 items"
        },
        {
          "name": "mxRecords",
          "description": "array expand_less List of hostnames and their priority."
        },
        {
          "name": "object expand_less hostname string The mail server hostname. priority integer The priority of the hostname.",
          "description": "hostname string The mail server hostname. priority integer The priority of the hostname."
        },
        {
          "name": "hostname",
          "description": "string The mail server hostname."
        },
        {
          "name": "priority",
          "description": "integer The priority of the hostname."
        },
        {
          "name": "status",
          "description": "string Status of domain. The following values are allowed: mx_ok, mx_error, mx_missing, mx_single_host, mx_priority_mismatch, mx_invalid_priority, mx_non_mimecast"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/internal-domains/verify/post",
      "last_updated": "2025-12-12T14:46:53.587086+00:00"
    },
    {
      "id": "pending-domains",
      "name": "Pending Domains",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/domain/cloud-gateway/v1/pending-domains",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/pending-domains/get",
      "last_updated": "2025-12-12T14:46:54.837790+00:00"
    },
    {
      "id": "pending-domains",
      "name": "Pending Domains",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/domain/cloud-gateway/v1/pending-domains",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/pending-domains/post",
      "last_updated": "2025-12-12T14:46:56.189426+00:00"
    },
    {
      "id": "{domain_id}",
      "name": "{Domain_Id}",
      "category": "Email Security Onboarding",
      "method": "DELETE",
      "path": "/domain/cloud-gateway/v1/pending-domains/{domain_id}",
      "description": "Description Deletes an unverified domain. Deletes an unverified domain.",
      "parameters": [
        {
          "name": "domain_id (required)",
          "description": "string Pending domain ID."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/domain/cloud-gateway/v1/pending-domains/%7Bdomain_id%7D/delete",
      "last_updated": "2025-12-12T14:46:58.826383+00:00"
    },
    {
      "id": "gateway-details",
      "name": "Gateway Details",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/email/cloud-gateway/v1/gateway-details",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/email/cloud-gateway/v1/gateway-details/get",
      "last_updated": "2025-12-12T14:47:01.445486+00:00"
    },
    {
      "id": "gateway-details",
      "name": "Gateway Details",
      "category": "Email Security Onboarding",
      "method": "PATCH",
      "path": "/email/cloud-gateway/v1/gateway-details",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/email/cloud-gateway/v1/gateway-details/patch",
      "last_updated": "2025-12-12T14:47:02.792557+00:00"
    },
    {
      "id": "outbound-ip-addresses",
      "name": "Outbound Ip Addresses",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/email/cloud-gateway/v1/outbound-ip-addresses",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/email/cloud-gateway/v1/outbound-ip-addresses/get",
      "last_updated": "2025-12-12T14:47:04.077157+00:00"
    },
    {
      "id": "outbound-ip-addresses",
      "name": "Outbound Ip Addresses",
      "category": "Email Security Onboarding",
      "method": "PUT",
      "path": "/email/cloud-gateway/v1/outbound-ip-addresses",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/email/cloud-gateway/v1/outbound-ip-addresses/put",
      "last_updated": "2025-12-12T14:47:05.423449+00:00"
    },
    {
      "id": "outbound-ip-addresses",
      "name": "Outbound Ip Addresses",
      "category": "Email Security Onboarding",
      "method": "DELETE",
      "path": "/email/cloud-gateway/v1/outbound-ip-addresses",
      "description": "Description Deletes all outbound IP Addresses for customer\u2019s mail platform. Deletes all outbound IP Addresses for customer\u2019s mail platform.",
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/email/cloud-gateway/v1/outbound-ip-addresses/delete",
      "last_updated": "2025-12-12T14:47:06.757381+00:00"
    },
    {
      "id": "statistics",
      "name": "Statistics",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/email/cloud-gateway/v1/statistics",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/email/cloud-gateway/v1/statistics/get",
      "last_updated": "2025-12-12T14:47:08.031310+00:00"
    },
    {
      "id": "services",
      "name": "Services",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/journaling/cloud-gateway/v1/services",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/journaling/cloud-gateway/v1/services/get",
      "last_updated": "2025-12-12T14:47:09.309669+00:00"
    },
    {
      "id": "services",
      "name": "Services",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/journaling/cloud-gateway/v1/services",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/journaling/cloud-gateway/v1/services/post",
      "last_updated": "2025-12-12T14:47:10.709472+00:00"
    },
    {
      "id": "{journaling_id}",
      "name": "{Journaling_Id}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/journaling/cloud-gateway/v1/services/{journaling_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/journaling/cloud-gateway/v1/services/%7Bjournaling_id%7D/get",
      "last_updated": "2025-12-12T14:47:11.994852+00:00"
    },
    {
      "id": "{journaling_id}",
      "name": "{Journaling_Id}",
      "category": "Email Security Onboarding",
      "method": "PATCH",
      "path": "/journaling/cloud-gateway/v1/services/{journaling_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/journaling/cloud-gateway/v1/services/%7Bjournaling_id%7D/patch",
      "last_updated": "2025-12-12T14:47:13.272645+00:00"
    },
    {
      "id": "{journaling_id}",
      "name": "{Journaling_Id}",
      "category": "Email Security Onboarding",
      "method": "DELETE",
      "path": "/journaling/cloud-gateway/v1/services/{journaling_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/journaling/cloud-gateway/v1/services/%7Bjournaling_id%7D/delete",
      "last_updated": "2025-12-12T14:47:14.552412+00:00"
    },
    {
      "id": "policies",
      "name": "Policies",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies",
      "description": "Description Gets all anti-spoofing bypass policies for an account. Gets all anti-spoofing bypass policies for an account.",
      "parameters": [
        {
          "name": "pageSize",
          "description": "integer (int32) 1 \u2264 value \u2264 100 The maximum number of rows to return per page."
        },
        {
          "name": "pageToken",
          "description": "Example open_in_new NDY6bnVsbA== NDY6bnVsbA== content_copy string Pagination page token."
        },
        {
          "name": "definitions",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less id string The policy ID. description string The policy description. option string Should apply anti-spoofing bypass or not. The following values are allowed: disable_bypass, enable_bypass fromPart string Which part of the email the policy should apply to. The following values are allowed: both from object expand_less The from policy target. type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value. to object expand_less The to policy target. type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value. enabled boolean Whether the policy is active or not. enforced boolean Whether the policy is enforced or not. fromDateTime string (date) The start date of the policy. toDateTime string (date) The end date of the policy. fromEternal boolean Whether the Policy start date is set to Eternal. toEternal boolean Whether the Policy end date is set to Eternal. override boolean Whether the policy should take precedence over similar policies. bidirectional boolean Whether the policy should apply to both outbound and inbound mail. spfDomains array Domain names whose SPF records should be checked to see if the connecting IP address has been referenced.",
          "description": "id string The policy ID. description string The policy description. option string Should apply anti-spoofing bypass or not. The following values are allowed: disable_bypass, enable_bypass fromPart string Which part of the email the policy should apply to. The following values are allowed: both from object expand_less The from policy target. type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value. type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value. to object expand_less The to policy target. type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value. type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value. enabled boolean Whether the policy is active or not. enforced boolean Whether the policy is enforced or not. fromDateTime string (date) The start date of the policy. toDateTime string (date) The end date of the policy. fromEternal boolean Whether the Policy start date is set to Eternal. toEternal boolean Whether the Policy end date is set to Eternal. override boolean Whether the policy should take precedence over similar policies. bidirectional boolean Whether the policy should apply to both outbound and inbound mail. spfDomains array Domain names whose SPF records should be checked to see if the connecting IP address has been referenced."
        },
        {
          "name": "id",
          "description": "string The policy ID."
        },
        {
          "name": "description",
          "description": "string The policy description."
        },
        {
          "name": "option",
          "description": "string Should apply anti-spoofing bypass or not. The following values are allowed: disable_bypass, enable_bypass"
        },
        {
          "name": "fromPart",
          "description": "string Which part of the email the policy should apply to. The following values are allowed: both"
        },
        {
          "name": "from",
          "description": "object expand_less The from policy target."
        },
        {
          "name": "type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value.",
          "description": "type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value."
        },
        {
          "name": "type",
          "description": "string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address"
        },
        {
          "name": "group",
          "description": "object expand_more The group details if type is profile_group."
        },
        {
          "name": "domain",
          "description": "string The domain name if type is email_domain."
        },
        {
          "name": "emailAddress",
          "description": "string The email address if type is individual_email_address."
        },
        {
          "name": "attribute",
          "description": "object expand_more The address attribute if type is address_attribute_value."
        },
        {
          "name": "to",
          "description": "object expand_less The to policy target."
        },
        {
          "name": "type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value.",
          "description": "type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address group object expand_more The group details if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_more The address attribute if type is address_attribute_value."
        },
        {
          "name": "type",
          "description": "string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address"
        },
        {
          "name": "group",
          "description": "object expand_more The group details if type is profile_group."
        },
        {
          "name": "domain",
          "description": "string The domain name if type is email_domain."
        },
        {
          "name": "emailAddress",
          "description": "string The email address if type is individual_email_address."
        },
        {
          "name": "attribute",
          "description": "object expand_more The address attribute if type is address_attribute_value."
        },
        {
          "name": "enabled",
          "description": "boolean Whether the policy is active or not."
        },
        {
          "name": "enforced",
          "description": "boolean Whether the policy is enforced or not."
        },
        {
          "name": "fromDateTime",
          "description": "string (date) The start date of the policy."
        },
        {
          "name": "toDateTime",
          "description": "string (date) The end date of the policy."
        },
        {
          "name": "fromEternal",
          "description": "boolean Whether the Policy start date is set to Eternal."
        },
        {
          "name": "toEternal",
          "description": "boolean Whether the Policy end date is set to Eternal."
        },
        {
          "name": "override",
          "description": "boolean Whether the policy should take precedence over similar policies."
        },
        {
          "name": "bidirectional",
          "description": "boolean Whether the policy should apply to both outbound and inbound mail."
        },
        {
          "name": "spfDomains",
          "description": "array Domain names whose SPF records should be checked to see if the connecting IP address has been referenced."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/get",
      "last_updated": "2025-12-12T14:47:15.903610+00:00"
    },
    {
      "id": "policies",
      "name": "Policies",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/post",
      "last_updated": "2025-12-12T14:47:17.171652+00:00"
    },
    {
      "id": "{policy_id}",
      "name": "{Policy_Id}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/{policy_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/%7Bpolicy_id%7D/get",
      "last_updated": "2025-12-12T14:47:18.588062+00:00"
    },
    {
      "id": "{policy_id}",
      "name": "{Policy_Id}",
      "category": "Email Security Onboarding",
      "method": "PATCH",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/{policy_id}",
      "description": "Description Updates a anti-spoofing policy for an account. Updates a anti-spoofing policy for an account.",
      "parameters": [
        {
          "name": "policy_id (required)",
          "description": "string Policy ID."
        },
        {
          "name": "description",
          "description": "string The policy description."
        },
        {
          "name": "option",
          "description": "string Should apply anti-spoofing bypas or not. The following values are allowed: disable_bypass, enable_bypass"
        },
        {
          "name": "fromPart",
          "description": "string Which part of the email the policy should apply to. The following values are allowed: both"
        },
        {
          "name": "from",
          "description": "object expand_less The from policy target."
        },
        {
          "name": "type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address groupId String The group ID if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_less The address attribute if type is address_attribute_value. id string The attribute ID. value string The attribute value.",
          "description": "type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address groupId String The group ID if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_less The address attribute if type is address_attribute_value. id string The attribute ID. value string The attribute value. id string The attribute ID. value string The attribute value."
        },
        {
          "name": "type",
          "description": "string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address"
        },
        {
          "name": "groupId",
          "description": "String The group ID if type is profile_group."
        },
        {
          "name": "domain",
          "description": "string The domain name if type is email_domain."
        },
        {
          "name": "emailAddress",
          "description": "string The email address if type is individual_email_address."
        },
        {
          "name": "attribute",
          "description": "object expand_less The address attribute if type is address_attribute_value."
        },
        {
          "name": "id string The attribute ID. value string The attribute value.",
          "description": "id string The attribute ID. value string The attribute value."
        },
        {
          "name": "id",
          "description": "string The attribute ID."
        },
        {
          "name": "value",
          "description": "string The attribute value."
        },
        {
          "name": "to",
          "description": "object expand_less The to policy target."
        },
        {
          "name": "type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address groupId String The group ID if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_less The address attribute if type is address_attribute_value. id string The attribute ID. value string The attribute value.",
          "description": "type string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address groupId String The group ID if type is profile_group. domain string The domain name if type is email_domain. emailAddress string The email address if type is individual_email_address. attribute object expand_less The address attribute if type is address_attribute_value. id string The attribute ID. value string The attribute value. id string The attribute ID. value string The attribute value."
        },
        {
          "name": "type",
          "description": "string The type of policy target. The following values are allowed: everyone, internal_addresses, external_addresses, email_domain, profile_group, address_attribute_value, individual_email_address"
        },
        {
          "name": "groupId",
          "description": "String The group ID if type is profile_group."
        },
        {
          "name": "domain",
          "description": "string The domain name if type is email_domain."
        },
        {
          "name": "emailAddress",
          "description": "string The email address if type is individual_email_address."
        },
        {
          "name": "attribute",
          "description": "object expand_less The address attribute if type is address_attribute_value."
        },
        {
          "name": "id string The attribute ID. value string The attribute value.",
          "description": "id string The attribute ID. value string The attribute value."
        },
        {
          "name": "id",
          "description": "string The attribute ID."
        },
        {
          "name": "value",
          "description": "string The attribute value."
        },
        {
          "name": "enabled",
          "description": "boolean Whether the policy is active or not."
        },
        {
          "name": "fromDateTime",
          "description": "string (date) The start date of the policy."
        },
        {
          "name": "toDateTime",
          "description": "string (date) The end date of the policy."
        },
        {
          "name": "fromEternal",
          "description": "boolean Whether the Policy start date is set to Eternal."
        },
        {
          "name": "toEternal",
          "description": "boolean Whether the Policy end date is set to Eternal."
        },
        {
          "name": "override",
          "description": "boolean Whether the policy should take precedence over similar policies."
        },
        {
          "name": "bidirectional",
          "description": "boolean Whether the policy should apply to both outbound and inbound mail."
        },
        {
          "name": "spfDomains",
          "description": "array Domain names whose SPF records should be checked to see if the connecting IP address has been referenced."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/%7Bpolicy_id%7D/patch",
      "last_updated": "2025-12-12T14:47:19.921914+00:00"
    },
    {
      "id": "{policy_id}",
      "name": "{Policy_Id}",
      "category": "Email Security Onboarding",
      "method": "DELETE",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/{policy_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/%7Bpolicy_id%7D/delete",
      "last_updated": "2025-12-12T14:47:21.263418+00:00"
    },
    {
      "id": "definitions",
      "name": "Definitions",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/get",
      "last_updated": "2025-12-12T14:47:29.241324+00:00"
    },
    {
      "id": "definitions",
      "name": "Definitions",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions",
      "description": "(required) stringDescription of delivery route definition. hostname (required) stringThe public hostname or IP address of email server for delivery route. port (required) numberThe port number to connect on. 1 \u2264 value \u2264 65535 Default value25 smtpAuthentication (required) objectexpand_lessSome organizations require SMTP authentication before Mimecast is allowed to deliver email to their servers, wh",
      "parameters": [
        {
          "name": "description (required)",
          "description": "string Description of delivery route definition."
        },
        {
          "name": "hostname (required)",
          "description": "string The public hostname or IP address of email server for delivery route."
        },
        {
          "name": "port (required)",
          "description": "number The port number to connect on. 1 \u2264 value \u2264 65535 Default value 25"
        },
        {
          "name": "smtpAuthentication (required)",
          "description": "object expand_less Some organizations require SMTP authentication before Mimecast is allowed to deliver email to their servers, which helps to increase the security measures for safe email delivery."
        },
        {
          "name": "authMechanisms (required) array List of authentication mechanisms. Multiple mechanisms can be enabled and they will be utilized in the order listed. username (required) string Specify the domain's username. password (required) string Specify the domain's password. domain string Specify the domain.",
          "description": "authMechanisms (required) array List of authentication mechanisms. Multiple mechanisms can be enabled and they will be utilized in the order listed. username (required) string Specify the domain's username. password (required) string Specify the domain's password. domain string Specify the domain."
        },
        {
          "name": "authMechanisms (required)",
          "description": "array List of authentication mechanisms. Multiple mechanisms can be enabled and they will be utilized in the order listed."
        },
        {
          "name": "username (required)",
          "description": "string Specify the domain's username."
        },
        {
          "name": "password (required)",
          "description": "string Specify the domain's password."
        },
        {
          "name": "domain",
          "description": "string Specify the domain."
        },
        {
          "name": "alternateRouteId",
          "description": "string Secure ID of alternate delivery route definition."
        },
        {
          "name": "authMechanisms (required)",
          "description": "array List of authentication mechanisms. Multiple mechanisms can be enabled and they will be utilized in the order listed."
        },
        {
          "name": "username (required)",
          "description": "string Specify the domain's username."
        },
        {
          "name": "password (required)",
          "description": "string Specify the domain's password."
        },
        {
          "name": "domain",
          "description": "string Specify the domain."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/post",
      "last_updated": "2025-12-12T14:47:30.537918+00:00"
    },
    {
      "id": "{definition_id}",
      "name": "{Definition_Id}",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions/{definition_id}",
      "description": "Description The Api endpoint can be used to get a delivery route definition with definition ID specified in the uri. The Api endpoint can be used to get a delivery route definition with definition ID specified in the uri.",
      "parameters": [
        {
          "name": "definition_id (required)",
          "description": "string Secure ID of delivery route definition."
        },
        {
          "name": "description",
          "description": "string Description of delivery route definition."
        },
        {
          "name": "hostname",
          "description": "string The public hostname or IP address of email server for delivery route."
        },
        {
          "name": "port",
          "description": "number The port number to connect on."
        },
        {
          "name": "authMechanisms",
          "description": "array List of authentication mechanisms. Multiple mechanisms can be enabled and they will be utilized in the order listed."
        },
        {
          "name": "username",
          "description": "string The domain's username."
        },
        {
          "name": "domain",
          "description": "string The domain."
        },
        {
          "name": "alternateRouteId",
          "description": "string Secure ID of alternate delivery route definition."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/%7Bdefinition_id%7D/get",
      "last_updated": "2025-12-12T14:47:31.851391+00:00"
    },
    {
      "id": "{definition_id}",
      "name": "{Definition_Id}",
      "category": "Email Security Onboarding",
      "method": "PATCH",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions/{definition_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/%7Bdefinition_id%7D/patch",
      "last_updated": "2025-12-12T14:47:33.229753+00:00"
    },
    {
      "id": "{definition_id}",
      "name": "{Definition_Id}",
      "category": "Email Security Onboarding",
      "method": "DELETE",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions/{definition_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/%7Bdefinition_id%7D/delete",
      "last_updated": "2025-12-12T14:47:34.581476+00:00"
    },
    {
      "id": "{definition_id}-verify",
      "name": "{Definition_Id}/Verify",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/policy-management/cloud-gateway/v1/dns-authentication-outbound/definitions/{definition_id}/verify",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/policy-management/cloud-gateway/v1/dns-authentication-outbound/definitions/%7Bdefinition_id%7D/verify/post",
      "last_updated": "2025-12-12T14:47:50.412078+00:00"
    },
    {
      "id": "-role-cloud-gateway-v1-roles",
      "name": "/Role/Cloud Gateway/V1/Roles",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/role/cloud-gateway/v1/roles",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/role/cloud-gateway/v1/roles/get",
      "last_updated": "2025-12-12T14:48:04.971462+00:00"
    },
    {
      "id": "users",
      "name": "Users",
      "category": "Email Security Onboarding",
      "method": "GET",
      "path": "/user/cloud-gateway/v1/users",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/user/cloud-gateway/v1/users/get",
      "last_updated": "2025-12-12T14:48:06.298662+00:00"
    },
    {
      "id": "users",
      "name": "Users",
      "category": "Email Security Onboarding",
      "method": "POST",
      "path": "/user/cloud-gateway/v1/users",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/emailsecurityonboarding/1/routes/user/cloud-gateway/v1/users/post",
      "last_updated": "2025-12-12T14:48:07.658696+00:00"
    },
    {
      "id": "create-address-alteration-set",
      "name": "Create Address Alteration Set",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/create-address-alteration-set",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/create-address-alteration-set/post",
      "last_updated": "2025-12-12T14:48:22.019189+00:00"
    },
    {
      "id": "create-definition",
      "name": "Create Definition",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/create-definition",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/create-definition/post",
      "last_updated": "2025-12-12T14:48:23.372720+00:00"
    },
    {
      "id": "create-policy",
      "name": "Create Policy",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/create-policy",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/create-policy/post",
      "last_updated": "2025-12-12T14:48:24.687261+00:00"
    },
    {
      "id": "delete-definition",
      "name": "Delete Definition",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/delete-definition",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/delete-definition/post",
      "last_updated": "2025-12-12T14:48:26.033217+00:00"
    },
    {
      "id": "delete-policy",
      "name": "Delete Policy",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/delete-policy",
      "description": "Description This API endpoint can be used to remove an existing Address Alteration policy. This API endpoint can be used to remove an existing Address Alteration policy.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  from 1 to 500 items"
        },
        {
          "name": "object expand_less id (required) string The Mimecast secure id of the policy to be deleted.",
          "description": "id (required) string The Mimecast secure id of the policy to be deleted."
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast secure id of the policy to be deleted."
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast secure id of the policy to be deleted."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/delete-policy/post",
      "last_updated": "2025-12-12T14:48:27.491750+00:00"
    },
    {
      "id": "get-address-alteration-set",
      "name": "Get Address Alteration Set",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/get-address-alteration-set",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/get-address-alteration-set/post",
      "last_updated": "2025-12-12T14:48:28.832264+00:00"
    },
    {
      "id": "get-definition",
      "name": "Get Definition",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/get-definition",
      "description": "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. 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.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less folderId string The folder containing one or more address alteration definitions. newAddress string The new address structure. Format should match one of: localPart@domainPart, @domainPart, localPart@ . All domains must be internal. originalAddress string The original address being considered for rewrite. Format should match one of: localPart@domainPart, @domainPart, localPart@ . All domains must be internal. routing string The address alteration definition route. Possible values are all, inbound or outbound. The following values are allowed: all, inbound, outbound",
          "description": "folderId string The folder containing one or more address alteration definitions. newAddress string The new address structure. Format should match one of: localPart@domainPart, @domainPart, localPart@ . All domains must be internal. originalAddress string The original address being considered for rewrite. Format should match one of: localPart@domainPart, @domainPart, localPart@ . All domains must be internal. routing string The address alteration definition route. Possible values are all, inbound or outbound. The following values are allowed: all, inbound, outbound"
        },
        {
          "name": "folderId",
          "description": "string The folder containing one or more address alteration definitions."
        },
        {
          "name": "newAddress",
          "description": "string The new address structure. Format should match one of: localPart@domainPart, @domainPart, localPart@ . All domains must be internal."
        },
        {
          "name": "originalAddress",
          "description": "string The original address being considered for rewrite. Format should match one of: localPart@domainPart, @domainPart, localPart@ . All domains must be internal."
        },
        {
          "name": "routing",
          "description": "string The address alteration definition route. Possible values are all, inbound or outbound. The following values are allowed: all, inbound, outbound"
        },
        {
          "name": "folderId",
          "description": "string The folder containing one or more address alteration definitions."
        },
        {
          "name": "newAddress",
          "description": "string The new address structure. Format should match one of: localPart@domainPart, @domainPart, localPart@ . All domains must be internal."
        },
        {
          "name": "originalAddress",
          "description": "string The original address being considered for rewrite. Format should match one of: localPart@domainPart, @domainPart, localPart@ . All domains must be internal."
        },
        {
          "name": "routing",
          "description": "string The address alteration definition route. Possible values are all, inbound or outbound. The following values are allowed: all, inbound, outbound"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/get-definition/post",
      "last_updated": "2025-12-12T14:48:30.222540+00:00"
    },
    {
      "id": "get-policy",
      "name": "Get Policy",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/get-policy",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/get-policy/post",
      "last_updated": "2025-12-12T14:48:31.518470+00:00"
    },
    {
      "id": "update-policy",
      "name": "Update Policy",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/address-alteration/update-policy",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/address-alteration/update-policy/post",
      "last_updated": "2025-12-12T14:48:32.822723+00:00"
    },
    {
      "id": "create-policy-with-targets",
      "name": "Create Policy With Targets",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/webwhiteurl/create-policy-with-targets",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/webwhiteurl/create-policy-with-targets/post",
      "last_updated": "2025-12-12T14:48:42.141024+00:00"
    },
    {
      "id": "delete-policy-with-targets",
      "name": "Delete Policy With Targets",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/webwhiteurl/delete-policy-with-targets",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/webwhiteurl/delete-policy-with-targets/post",
      "last_updated": "2025-12-12T14:48:43.480376+00:00"
    },
    {
      "id": "get-policy-with-targets",
      "name": "Get Policy With Targets",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/webwhiteurl/get-policy-with-targets",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/webwhiteurl/get-policy-with-targets/post",
      "last_updated": "2025-12-12T14:48:44.812670+00:00"
    },
    {
      "id": "update-policy-with-targets",
      "name": "Update Policy With Targets",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/policy/webwhiteurl/update-policy-with-targets",
      "description": "Description This endpoint can be used to update an existing Web Security Block or Allow List policy for domains or URLs. 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. 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 . For more information about Web Security Policies, visit Mimecaster Central Mimecaster Central Mimecaster Central .",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less description string A description of the policies for future reference. id (required) string The Mimecast secure Id of an existing policy to be updated. policies (required) array expand_less The policy scoping details object expand_more urls array expand_less The URLs to be applied by this policy, and the actions to be taken per-URL. object expand_more",
          "description": "description string A description of the policies for future reference. id (required) string The Mimecast secure Id of an existing policy to be updated. policies (required) array expand_less The policy scoping details object expand_more urls array expand_less The URLs to be applied by this policy, and the actions to be taken per-URL. object expand_more"
        },
        {
          "name": "description",
          "description": "string A description of the policies for future reference."
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast secure Id of an existing policy to be updated."
        },
        {
          "name": "policies (required)",
          "description": "array expand_less The policy scoping details"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "urls",
          "description": "array expand_less The URLs to be applied by this policy, and the actions to be taken per-URL."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "description",
          "description": "string A description of the policies for future reference."
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast secure Id of an existing policy to be updated."
        },
        {
          "name": "policies (required)",
          "description": "array expand_less The policy scoping details"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "urls",
          "description": "array expand_less The URLs to be applied by this policy, and the actions to be taken per-URL."
        },
        {
          "name": "object expand_more",
          "description": ""
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/policy/webwhiteurl/update-policy-with-targets/post",
      "last_updated": "2025-12-12T14:48:46.137373+00:00"
    },
    {
      "id": "create-managed-url",
      "name": "Create Managed Url",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/ttp/url/create-managed-url",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/ttp/url/create-managed-url/post",
      "last_updated": "2025-12-12T14:48:47.513047+00:00"
    },
    {
      "id": "delete-managed-url",
      "name": "Delete Managed Url",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/ttp/url/delete-managed-url",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/ttp/url/delete-managed-url/post",
      "last_updated": "2025-12-12T14:48:48.780006+00:00"
    },
    {
      "id": "get-all-managed-urls",
      "name": "Get All Managed Urls",
      "category": "Policy Management",
      "method": "POST",
      "path": "/api/ttp/url/get-all-managed-urls",
      "description": "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. 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. 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.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain at most 1 item"
        },
        {
          "name": "object expand_less domainOrComment string Domain or comment to look up for in managed urls. domainOrUrl string A domain or URL to filter results. exactMatch boolean If true, the domainOrUrl value to act as an exact match value. If false, any partial matches will be returned. Default value is false. filterBy array expand_less Array of filters to be applied for override type (fieldName:overridetype). Possible values are: all, permitted or blocked. object expand_more sortByUrl boolean Should sorting be applied by URL. Default is false. sortOrder string Sort in ascending or descending order. Sorting will be enabled only if \"sortByUrl\" is used. Default is ascending. The following values are allowed: asc, desc",
          "description": "domainOrComment string Domain or comment to look up for in managed urls. domainOrUrl string A domain or URL to filter results. exactMatch boolean If true, the domainOrUrl value to act as an exact match value. If false, any partial matches will be returned. Default value is false. filterBy array expand_less Array of filters to be applied for override type (fieldName:overridetype). Possible values are: all, permitted or blocked. object expand_more sortByUrl boolean Should sorting be applied by URL. Default is false. sortOrder string Sort in ascending or descending order. Sorting will be enabled only if \"sortByUrl\" is used. Default is ascending. The following values are allowed: asc, desc"
        },
        {
          "name": "domainOrComment",
          "description": "string Domain or comment to look up for in managed urls."
        },
        {
          "name": "domainOrUrl",
          "description": "string A domain or URL to filter results."
        },
        {
          "name": "exactMatch",
          "description": "boolean If true, the domainOrUrl value to act as an exact match value. If false, any partial matches will be returned. Default value is false."
        },
        {
          "name": "filterBy",
          "description": "array expand_less Array of filters to be applied for override type (fieldName:overridetype). Possible values are: all, permitted or blocked."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "sortByUrl",
          "description": "boolean Should sorting be applied by URL. Default is false."
        },
        {
          "name": "sortOrder",
          "description": "string Sort in ascending or descending order. Sorting will be enabled only if \"sortByUrl\" is used. Default is ascending. The following values are allowed: asc, desc"
        },
        {
          "name": "domainOrComment",
          "description": "string Domain or comment to look up for in managed urls."
        },
        {
          "name": "domainOrUrl",
          "description": "string A domain or URL to filter results."
        },
        {
          "name": "exactMatch",
          "description": "boolean If true, the domainOrUrl value to act as an exact match value. If false, any partial matches will be returned. Default value is false."
        },
        {
          "name": "filterBy",
          "description": "array expand_less Array of filters to be applied for override type (fieldName:overridetype). Possible values are: all, permitted or blocked."
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "sortByUrl",
          "description": "boolean Should sorting be applied by URL. Default is false."
        },
        {
          "name": "sortOrder",
          "description": "string Sort in ascending or descending order. Sorting will be enabled only if \"sortByUrl\" is used. Default is ascending. The following values are allowed: asc, desc"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/api/ttp/url/get-all-managed-urls/post",
      "last_updated": "2025-12-12T14:48:50.105231+00:00"
    },
    {
      "id": "policies",
      "name": "Policies",
      "category": "Policy Management",
      "method": "GET",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/get",
      "last_updated": "2025-12-12T14:48:51.358284+00:00"
    },
    {
      "id": "policies",
      "name": "Policies",
      "category": "Policy Management",
      "method": "POST",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/post",
      "last_updated": "2025-12-12T14:48:52.616076+00:00"
    },
    {
      "id": "{policy_id}",
      "name": "{Policy_Id}",
      "category": "Policy Management",
      "method": "GET",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/{policy_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/%7Bpolicy_id%7D/get",
      "last_updated": "2025-12-12T14:48:53.901040+00:00"
    },
    {
      "id": "{policy_id}",
      "name": "{Policy_Id}",
      "category": "Policy Management",
      "method": "PATCH",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/{policy_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/%7Bpolicy_id%7D/patch",
      "last_updated": "2025-12-12T14:48:55.175062+00:00"
    },
    {
      "id": "{policy_id}",
      "name": "{Policy_Id}",
      "category": "Policy Management",
      "method": "DELETE",
      "path": "/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/{policy_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/anti-spoofing-bypass/policies/%7Bpolicy_id%7D/delete",
      "last_updated": "2025-12-12T14:48:56.439157+00:00"
    },
    {
      "id": "definitions",
      "name": "Definitions",
      "category": "Policy Management",
      "method": "GET",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/get",
      "last_updated": "2025-12-12T14:49:10.604459+00:00"
    },
    {
      "id": "definitions",
      "name": "Definitions",
      "category": "Policy Management",
      "method": "POST",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/post",
      "last_updated": "2025-12-12T14:49:11.877114+00:00"
    },
    {
      "id": "{definition_id}",
      "name": "{Definition_Id}",
      "category": "Policy Management",
      "method": "GET",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions/{definition_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/%7Bdefinition_id%7D/get",
      "last_updated": "2025-12-12T14:49:13.144960+00:00"
    },
    {
      "id": "{definition_id}",
      "name": "{Definition_Id}",
      "category": "Policy Management",
      "method": "PATCH",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions/{definition_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/%7Bdefinition_id%7D/patch",
      "last_updated": "2025-12-12T14:49:14.466028+00:00"
    },
    {
      "id": "{definition_id}",
      "name": "{Definition_Id}",
      "category": "Policy Management",
      "method": "DELETE",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/definitions/{definition_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/delivery-route/definitions/%7Bdefinition_id%7D/delete",
      "last_updated": "2025-12-12T14:49:15.806456+00:00"
    },
    {
      "id": "verify",
      "name": "Verify",
      "category": "Policy Management",
      "method": "POST",
      "path": "/policy-management/cloud-gateway/v1/delivery-route/verify",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/delivery-route/verify/post",
      "last_updated": "2025-12-12T14:49:23.828975+00:00"
    },
    {
      "id": "{definition_id}-verify",
      "name": "{Definition_Id}/Verify",
      "category": "Policy Management",
      "method": "POST",
      "path": "/policy-management/cloud-gateway/v1/dns-authentication-outbound/definitions/{definition_id}/verify",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/policymanagement/1/routes/policy-management/cloud-gateway/v1/dns-authentication-outbound/definitions/%7Bdefinition_id%7D/verify/post",
      "last_updated": "2025-12-12T14:49:31.531231+00:00"
    },
    {
      "id": "batch-events-cg",
      "name": "Batch/Events/Cg",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/siem/v1/batch/events/cg",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/siem/v1/batch/events/cg/get",
      "last_updated": "2025-12-12T14:50:00.560701+00:00"
    },
    {
      "id": "events-cg",
      "name": "Events/Cg",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/siem/v1/events/cg",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/siem/v1/events/cg/get",
      "last_updated": "2025-12-12T14:50:01.920106+00:00"
    },
    {
      "id": "reported-emails",
      "name": "Reported Emails",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threat-reporting/v1/reported-emails",
      "description": "Description This API retrieves a list of reported emails within a specified time range, sorted in descending order by the last reported date (lastReportedDate). This API retrieves a list of reported emails within a specified time range, sorted in descending order by the last reported date (lastReportedDate).",
      "parameters": [
        {
          "name": "dateRangeStartsAt",
          "description": "Example open_in_new 2023-03-19T13:30:45.+000 2023-03-19T13:30:45.+000 content_copy string The date in ISO-8601 format from which to start, default a week from the current time."
        },
        {
          "name": "dateRangeEndsAt",
          "description": "Example open_in_new 2023-03-20T13:30:45+000 2023-03-20T13:30:45+000 content_copy string The date in ISO-8601 format from which to end, default to the current time."
        },
        {
          "name": "pageSize",
          "description": "string The number of results to return per page. Page size of 25,50,100,250,500, if missing default value is 50"
        },
        {
          "name": "offset",
          "description": "string The number of pages to offset before returning results, starting from 0"
        },
        {
          "name": "message",
          "description": "object expand_less"
        },
        {
          "name": "messageId string The internet message id of the email. messageAggregateId string The message aggregate id of the email. subject string The subject of the email (encoded). sentDate string (date-time) The sent date of the email. lastReportedDate string (date-time) The last reported date of the analysis. senderHeaders array The sender headers of the email.(from, reply-to, return-path) recipientsCount integer (int32) The number of recipients of the email. 0 \u2264 value reportersCount integer (int32) The number of recipients reporting the email. 0 \u2264 value recipients array The recipients of the email.",
          "description": "messageId string The internet message id of the email. messageAggregateId string The message aggregate id of the email. subject string The subject of the email (encoded). sentDate string (date-time) The sent date of the email. lastReportedDate string (date-time) The last reported date of the analysis. senderHeaders array The sender headers of the email.(from, reply-to, return-path) recipientsCount integer (int32) The number of recipients of the email. 0 \u2264 value reportersCount integer (int32) The number of recipients reporting the email. 0 \u2264 value recipients array The recipients of the email."
        },
        {
          "name": "messageId",
          "description": "string The internet message id of the email."
        },
        {
          "name": "messageAggregateId",
          "description": "string The message aggregate id of the email."
        },
        {
          "name": "subject",
          "description": "string The subject of the email (encoded)."
        },
        {
          "name": "sentDate",
          "description": "string (date-time) The sent date of the email."
        },
        {
          "name": "lastReportedDate",
          "description": "string (date-time) The last reported date of the analysis."
        },
        {
          "name": "senderHeaders",
          "description": "array The sender headers of the email.(from, reply-to, return-path)"
        },
        {
          "name": "recipientsCount",
          "description": "integer (int32) The number of recipients of the email. 0 \u2264 value"
        },
        {
          "name": "reportersCount",
          "description": "integer (int32) The number of recipients reporting the email. 0 \u2264 value"
        },
        {
          "name": "recipients",
          "description": "array The recipients of the email."
        },
        {
          "name": "threatAnalysis",
          "description": "object expand_less"
        },
        {
          "name": "threatAnalysisId string The id of the latest analysis. resolvedDate string (date-time) The date when of the latest analysis was resolved. classification string The classification of the latest analysis details string Details on the classification of the latest analysis type string The type of the latest analysis The following values are allowed: MSOC",
          "description": "threatAnalysisId string The id of the latest analysis. resolvedDate string (date-time) The date when of the latest analysis was resolved. classification string The classification of the latest analysis details string Details on the classification of the latest analysis type string The type of the latest analysis The following values are allowed: MSOC"
        },
        {
          "name": "threatAnalysisId",
          "description": "string The id of the latest analysis."
        },
        {
          "name": "resolvedDate",
          "description": "string (date-time) The date when of the latest analysis was resolved."
        },
        {
          "name": "classification",
          "description": "string The classification of the latest analysis"
        },
        {
          "name": "details",
          "description": "string Details on the classification of the latest analysis"
        },
        {
          "name": "type",
          "description": "string The type of the latest analysis The following values are allowed: MSOC"
        },
        {
          "name": "threatReports",
          "description": "string (uri) URL of the referenced reporters list on the threat reports resource"
        },
        {
          "name": "meta",
          "description": "object expand_less"
        },
        {
          "name": "nextPage string (uri) URL to retrieve the next page of results",
          "description": "nextPage string (uri) URL to retrieve the next page of results"
        },
        {
          "name": "nextPage",
          "description": "string (uri) URL to retrieve the next page of results"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threat-reporting/v1/reported-emails/get",
      "last_updated": "2025-12-12T14:50:03.306718+00:00"
    },
    {
      "id": "reported-emails-{reportedmessageaggregateid}",
      "name": "Reported Emails/{Reportedmessageaggregateid}",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threat-reporting/v1/reported-emails/{reportedMessageAggregateId}",
      "description": "Description This API retrieves reported email with latest analysis and list of reporters based on reported message aggregate id. The threat reported message aggregate id can be obtained using the Reported Emails API or from a threat-analysis notification details. This API retrieves reported email with latest analysis and list of reporters based on reported message aggregate id. The threat reported message aggregate id can be obtained using the Reported Emails API or from a threat-analysis notification details.",
      "parameters": [
        {
          "name": "reportedMessageAggregateId (required)",
          "description": "string The the reported message aggregateId"
        },
        {
          "name": "message",
          "description": "object expand_less"
        },
        {
          "name": "messageId string The internet message id of the email. messageAggregateId string The message aggregate id of the email. subject string The subject of the email (encoded). sentDate string (date-time) The sent date of the email. lastReportedDate string (date-time) The last reported date of the analysis. senderHeaders array The sender headers of the email.(from, reply-to, return-path) recipientsCount integer (int32) The number of recipients of the email. 0 \u2264 value reportersCount integer (int32) The number of recipients reporting the email. 0 \u2264 value recipients array The recipients of the email.",
          "description": "messageId string The internet message id of the email. messageAggregateId string The message aggregate id of the email. subject string The subject of the email (encoded). sentDate string (date-time) The sent date of the email. lastReportedDate string (date-time) The last reported date of the analysis. senderHeaders array The sender headers of the email.(from, reply-to, return-path) recipientsCount integer (int32) The number of recipients of the email. 0 \u2264 value reportersCount integer (int32) The number of recipients reporting the email. 0 \u2264 value recipients array The recipients of the email."
        },
        {
          "name": "messageId",
          "description": "string The internet message id of the email."
        },
        {
          "name": "messageAggregateId",
          "description": "string The message aggregate id of the email."
        },
        {
          "name": "subject",
          "description": "string The subject of the email (encoded)."
        },
        {
          "name": "sentDate",
          "description": "string (date-time) The sent date of the email."
        },
        {
          "name": "lastReportedDate",
          "description": "string (date-time) The last reported date of the analysis."
        },
        {
          "name": "senderHeaders",
          "description": "array The sender headers of the email.(from, reply-to, return-path)"
        },
        {
          "name": "recipientsCount",
          "description": "integer (int32) The number of recipients of the email. 0 \u2264 value"
        },
        {
          "name": "reportersCount",
          "description": "integer (int32) The number of recipients reporting the email. 0 \u2264 value"
        },
        {
          "name": "recipients",
          "description": "array The recipients of the email."
        },
        {
          "name": "threatAnalysis",
          "description": "object expand_less"
        },
        {
          "name": "threatAnalysisId string The id of the latest analysis. date string (date-time) The date of the latest analysis. classification string The classification of the latest analysis details string Details on the classification of the latest analysis type string The type of the latest analysis The following values are allowed: Auto, MSOC, Customer",
          "description": "threatAnalysisId string The id of the latest analysis. date string (date-time) The date of the latest analysis. classification string The classification of the latest analysis details string Details on the classification of the latest analysis type string The type of the latest analysis The following values are allowed: Auto, MSOC, Customer"
        },
        {
          "name": "threatAnalysisId",
          "description": "string The id of the latest analysis."
        },
        {
          "name": "date",
          "description": "string (date-time) The date of the latest analysis."
        },
        {
          "name": "classification",
          "description": "string The classification of the latest analysis"
        },
        {
          "name": "details",
          "description": "string Details on the classification of the latest analysis"
        },
        {
          "name": "type",
          "description": "string The type of the latest analysis The following values are allowed: Auto, MSOC, Customer"
        },
        {
          "name": "threatReports",
          "description": "string (uri) URL of the referenced reporters list on the threat reports resource"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threat-reporting/v1/reported-emails/%7BreportedMessageAggregateId%7D/get",
      "last_updated": "2025-12-12T14:50:04.670031+00:00"
    },
    {
      "id": "subscriptions",
      "name": "Subscriptions",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threat-reporting/v1/subscriptions",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threat-reporting/v1/subscriptions/get",
      "last_updated": "2025-12-12T14:50:05.982714+00:00"
    },
    {
      "id": "subscriptions",
      "name": "Subscriptions",
      "category": "Threats, Security Events and Data for CG",
      "method": "POST",
      "path": "/threat-reporting/v1/subscriptions",
      "description": "Description This API create a notification subscriptions for a resource of type \"threat-analysis\". This API create a notification subscriptions for a resource of type \"threat-analysis\".",
      "parameters": [
        {
          "name": "clientState",
          "description": "string Example Customer generated unique identifier, will be used to validate Mimecast as the caller."
        },
        {
          "name": "notificationURL",
          "description": "string (uri) A valid HTTPs URL. of the webhook"
        },
        {
          "name": "resourceType",
          "description": "string Type of notification linked to the subscription, at the moment only threat-analysis is supported The following values are allowed: threat-analysis"
        },
        {
          "name": "subscriptionId",
          "description": "string Subscription unique id in the Mimecast system"
        },
        {
          "name": "expirationDateTime",
          "description": "string (date-time) Subscription expiration date and time in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ssZ)"
        },
        {
          "name": "creationDateTime",
          "description": "string (date-time) Subscription create date and time in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ssZ)"
        },
        {
          "name": "resourceType",
          "description": "string Type of notification linked to the subscription, at the moment only threat-analysis is supported The following values are allowed: threat-analysis"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threat-reporting/v1/subscriptions/post",
      "last_updated": "2025-12-12T14:50:07.388481+00:00"
    },
    {
      "id": "{subscriptionid}",
      "name": "{Subscriptionid}",
      "category": "Threats, Security Events and Data for CG",
      "method": "PATCH",
      "path": "/threat-reporting/v1/subscriptions/{subscriptionId}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threat-reporting/v1/subscriptions/%7BsubscriptionId%7D/patch",
      "last_updated": "2025-12-12T14:50:08.670376+00:00"
    },
    {
      "id": "{subscriptionid}",
      "name": "{Subscriptionid}",
      "category": "Threats, Security Events and Data for CG",
      "method": "DELETE",
      "path": "/threat-reporting/v1/subscriptions/{subscriptionId}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threat-reporting/v1/subscriptions/%7BsubscriptionId%7D/delete",
      "last_updated": "2025-12-12T14:50:09.950822+00:00"
    },
    {
      "id": "threat-analysis-{threatanalysisid}",
      "name": "Threat Analysis/{Threatanalysisid}",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threat-reporting/v1/threat-analysis/{threatAnalysisId}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threat-reporting/v1/threat-analysis/%7BthreatAnalysisId%7D/get",
      "last_updated": "2025-12-12T14:50:11.216379+00:00"
    },
    {
      "id": "threat-reports",
      "name": "Threat Reports",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threat-reporting/v1/threat-reports",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threat-reporting/v1/threat-reports/get",
      "last_updated": "2025-12-12T14:50:12.483224+00:00"
    },
    {
      "id": "events",
      "name": "Events",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/events",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/events/get",
      "last_updated": "2025-12-12T14:50:13.752989+00:00"
    },
    {
      "id": "events-{id}-details",
      "name": "Events/{Id}/Details",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/events/{id}/details",
      "description": "Description This API endpoint can be used you to retrieve comprehensive details about a specific email identified by Mimecast, including information about the sender, recipients, subject line, and a summary of detected threats, along with details on any associated files and clicked URLs. This document provides a basic overview of the endpoint This API endpoint can be used you to retrieve comprehensive details about a specific email identified by Mimecast, including information about the sender, recipients, subject line, and a summary of detected threats, along with details on any associated files and clicked URLs. This document provides a basic overview of the endpoint",
      "parameters": [
        {
          "name": "id (required)",
          "description": "string Example matches ^[A-Za-z0-9_-]+$ Detection Id."
        },
        {
          "name": "source (required)",
          "description": "string The following values are allowed: EMAIL Default value \"EMAIL\" Filter parameter to get the threat details statistics for the relevant service(s)"
        },
        {
          "name": "pageSize (required)",
          "description": "integer 1 \u2264 value \u2264 100 Default value 100 Max pageSize to fetch sub-collections(attachments, urls, recipients)"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/events/%7Bid%7D/details/get",
      "last_updated": "2025-12-12T14:50:15.097964+00:00"
    },
    {
      "id": "attachment-scans",
      "name": "Attachment Scans",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/attachment-scans",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/attachment-scans/get",
      "last_updated": "2025-12-12T14:50:16.373715+00:00"
    },
    {
      "id": "gateway-detections",
      "name": "Gateway Detections",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/gateway-detections",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/gateway-detections/get",
      "last_updated": "2025-12-12T14:50:17.645120+00:00"
    },
    {
      "id": "impersonations",
      "name": "Impersonations",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/impersonations",
      "description": "Description This API can be used to retrieve number of impersonation detections triggered by at least one impersonation detect policy. This API can be used to retrieve number of impersonation detections triggered by at least one impersonation detect policy.",
      "parameters": [
        {
          "name": "timestampRangeStartsAt (required)",
          "description": "Example open_in_new 2023-04-17T00:00:00.000+05:30[Asia/Kolkata] 2023-04-17T00:00:00.000+05:30[Asia/Kolkata] content_copy string (date-time) Start timestamp (inclusive) to retrieve data from. Extended ISO-8601 format with mandatory time zone designator. Note: Data is only available for 90 days."
        },
        {
          "name": "timestampRangeEndsAt",
          "description": "Example open_in_new 2023-08-18T00:00:00.000+05:30[Asia/Kolkata] 2023-08-18T00:00:00.000+05:30[Asia/Kolkata] content_copy string (date-time) End timestamp (exclusive) to retrieve data up to. Extended ISO-8601 format with mandatory time zone designator (which must be the same as the one specified in the timestampRangeStartsAt field). Default to current timestamp if not provided. Note: Data is only available for 90 days."
        },
        {
          "name": "value (required)",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less Aggregation data points for the requested statistics. startTimestamp (required) string (date-time) Example Beginning of the aggregation bucket for the data point. detectionCount (required) integer Number of detection events.",
          "description": "startTimestamp (required) string (date-time) Example Beginning of the aggregation bucket for the data point. detectionCount (required) integer Number of detection events."
        },
        {
          "name": "startTimestamp (required)",
          "description": "string (date-time) Example Beginning of the aggregation bucket for the data point."
        },
        {
          "name": "detectionCount (required)",
          "description": "integer Number of detection events."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/impersonations/get",
      "last_updated": "2025-12-12T14:50:18.934888+00:00"
    },
    {
      "id": "phishing",
      "name": "Phishing",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/phishing",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/phishing/get",
      "last_updated": "2025-12-12T14:50:20.204041+00:00"
    },
    {
      "id": "suspicious",
      "name": "Suspicious",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/suspicious",
      "description": "Description This API can be used to retrieve number of suspicious detections, which are potentially malicious messages, files or URLs. The aggregation encompasses messages held or blocked due to spam where the rejection reason is suspicious,  and URL clicks categorised as suspicious, compromised, botnets, dangerous files downloaded and private IP addresses. This API can be used to retrieve number of suspicious detections, which are potentially malicious messages, files or URLs. The aggregation encompasses messages held or blocked due to spam where the rejection reason is suspicious,  and URL clicks categorised as suspicious, compromised, botnets, dangerous files downloaded and private IP addresses.",
      "parameters": [
        {
          "name": "timestampRangeStartsAt (required)",
          "description": "Example open_in_new 2023-04-17T00:00:00.000+05:30[Asia/Kolkata] 2023-04-17T00:00:00.000+05:30[Asia/Kolkata] content_copy string (date-time) Start timestamp (inclusive) to retrieve data from. Extended ISO-8601 format with mandatory time zone designator. Note: Data is only available for 90 days."
        },
        {
          "name": "timestampRangeEndsAt",
          "description": "Example open_in_new 2023-08-18T00:00:00.000+05:30[Asia/Kolkata] 2023-08-18T00:00:00.000+05:30[Asia/Kolkata] content_copy string (date-time) End timestamp (exclusive) to retrieve data up to. Extended ISO-8601 format with mandatory time zone designator (which must be the same as the one specified in the timestampRangeStartsAt field). Default to current timestamp if not provided. Note: Data is only available for 90 days."
        },
        {
          "name": "value (required)",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less Aggregation data points for the requested statistics. startTimestamp (required) string (date-time) Example Beginning of the aggregation bucket for the data point. detectionCount (required) integer Number of detection events.",
          "description": "startTimestamp (required) string (date-time) Example Beginning of the aggregation bucket for the data point. detectionCount (required) integer Number of detection events."
        },
        {
          "name": "startTimestamp (required)",
          "description": "string (date-time) Example Beginning of the aggregation bucket for the data point."
        },
        {
          "name": "detectionCount (required)",
          "description": "integer Number of detection events."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/suspicious/get",
      "last_updated": "2025-12-12T14:50:21.517064+00:00"
    },
    {
      "id": "threats-by-recipient",
      "name": "Threats By Recipient",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/threats-by-recipient",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/threats-by-recipient/get",
      "last_updated": "2025-12-12T14:50:22.795785+00:00"
    },
    {
      "id": "threats-by-sender",
      "name": "Threats By Sender",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/threats-by-sender",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/threats-by-sender/get",
      "last_updated": "2025-12-12T14:50:24.075193+00:00"
    },
    {
      "id": "unwanted",
      "name": "Unwanted",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/unwanted",
      "description": "Description This API can be used to retrieve number of unwanted detections, which are managed by custom URL blocklists This API can be used to retrieve number of unwanted detections, which are managed by custom URL blocklists",
      "parameters": [
        {
          "name": "timestampRangeStartsAt (required)",
          "description": "Example open_in_new 2023-04-17T00:00:00.000+05:30[Asia/Kolkata] 2023-04-17T00:00:00.000+05:30[Asia/Kolkata] content_copy string (date-time) Start timestamp (inclusive) to retrieve data from. Extended ISO-8601 format with mandatory time zone designator. Note: Data is only available for 90 days."
        },
        {
          "name": "timestampRangeEndsAt",
          "description": "Example open_in_new 2023-08-18T00:00:00.000+05:30[Asia/Kolkata] 2023-08-18T00:00:00.000+05:30[Asia/Kolkata] content_copy string (date-time) End timestamp (exclusive) to retrieve data up to. Extended ISO-8601 format with mandatory time zone designator (which must be the same as the one specified in the timestampRangeStartsAt field). Default to current timestamp if not provided. Note: Data is only available for 90 days."
        },
        {
          "name": "value (required)",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less Aggregation data points for the requested statistics. startTimestamp (required) string (date-time) Example Beginning of the aggregation bucket for the data point. detectionCount (required) integer Number of detection events.",
          "description": "startTimestamp (required) string (date-time) Example Beginning of the aggregation bucket for the data point. detectionCount (required) integer Number of detection events."
        },
        {
          "name": "startTimestamp (required)",
          "description": "string (date-time) Example Beginning of the aggregation bucket for the data point."
        },
        {
          "name": "detectionCount (required)",
          "description": "integer Number of detection events."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/unwanted/get",
      "last_updated": "2025-12-12T14:50:25.365765+00:00"
    },
    {
      "id": "url-clicks",
      "name": "Url Clicks",
      "category": "Threats, Security Events and Data for CG",
      "method": "GET",
      "path": "/threats/v1/stats/url-clicks",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatssecurityeventsanddataforcg/1/routes/threats/v1/stats/url-clicks/get",
      "last_updated": "2025-12-12T14:50:26.618342+00:00"
    },
    {
      "id": "create-batch",
      "name": "Create Batch",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/byo-threat-intelligence/create-batch",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/byo-threat-intelligence/create-batch/post",
      "last_updated": "2025-12-12T14:50:35.096405+00:00"
    },
    {
      "id": "delete-batch",
      "name": "Delete Batch",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/byo-threat-intelligence/delete-batch",
      "description": "Description This endpoint can be used to remove a batch of indicators. This endpoint can be used to remove a batch of indicators.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less id (required) string The Mimecast secure ID of a batch to be deleted.",
          "description": "id (required) string The Mimecast secure ID of a batch to be deleted."
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast secure ID of a batch to be deleted."
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast secure ID of a batch to be deleted."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/byo-threat-intelligence/delete-batch/post",
      "last_updated": "2025-12-12T14:50:36.435150+00:00"
    },
    {
      "id": "get-batches",
      "name": "Get Batches",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/byo-threat-intelligence/get-batches",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/byo-threat-intelligence/get-batches/post",
      "last_updated": "2025-12-12T14:50:37.720019+00:00"
    },
    {
      "id": "get-quota",
      "name": "Get Quota",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/byo-threat-intelligence/get-quota",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/byo-threat-intelligence/get-quota/post",
      "last_updated": "2025-12-12T14:50:38.978583+00:00"
    },
    {
      "id": "create",
      "name": "Create",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/ttp/remediation/create",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/ttp/remediation/create/post",
      "last_updated": "2025-12-12T14:50:40.264280+00:00"
    },
    {
      "id": "find-incidents",
      "name": "Find Incidents",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/ttp/remediation/find-incidents",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/ttp/remediation/find-incidents/post",
      "last_updated": "2025-12-12T14:50:41.539890+00:00"
    },
    {
      "id": "get-incident",
      "name": "Get Incident",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/ttp/remediation/get-incident",
      "description": "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. 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.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  from 1 to 25 items"
        },
        {
          "name": "object expand_less id (required) string The Mimecast ID for a remediation incident, provided when an incident is created",
          "description": "id (required) string The Mimecast ID for a remediation incident, provided when an incident is created"
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast ID for a remediation incident, provided when an incident is created"
        },
        {
          "name": "id (required)",
          "description": "string The Mimecast ID for a remediation incident, provided when an incident is created"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/ttp/remediation/get-incident/post",
      "last_updated": "2025-12-12T14:50:42.821353+00:00"
    },
    {
      "id": "search-hash",
      "name": "Search Hash",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/ttp/remediation/search-hash",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/ttp/remediation/search-hash/post",
      "last_updated": "2025-12-12T14:50:44.081506+00:00"
    },
    {
      "id": "v2-create",
      "name": "V2/Create",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/ttp/remediation/v2/create",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/ttp/remediation/v2/create/post",
      "last_updated": "2025-12-12T14:50:45.350866+00:00"
    },
    {
      "id": "threat-intel-get-feed",
      "name": "Threat Intel/Get Feed",
      "category": "Threat Management",
      "method": "POST",
      "path": "/api/ttp/threat-intel/get-feed",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/threatmanagement/1/routes/api/ttp/threat-intel/get-feed/post",
      "last_updated": "2025-12-12T14:50:46.634310+00:00"
    },
    {
      "id": "add-group-member",
      "name": "Add Group Member",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/add-group-member",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/add-group-member/post",
      "last_updated": "2025-12-12T14:51:33.237269+00:00"
    },
    {
      "id": "create-group",
      "name": "Create Group",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/create-group",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/create-group/post",
      "last_updated": "2025-12-12T14:51:34.520787+00:00"
    },
    {
      "id": "delete-group",
      "name": "Delete Group",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/delete-group",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/delete-group/post",
      "last_updated": "2025-12-12T14:51:35.772972+00:00"
    },
    {
      "id": "execute-sync",
      "name": "Execute Sync",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/execute-sync",
      "description": "Description This endpoint can be used to initiate directory synchronization. This endpoint can be used to initiate directory synchronization.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less syncStatus string The status of the directory synchronization process: \"started\" if started. type string The type of the Directory Connector.",
          "description": "syncStatus string The status of the directory synchronization process: \"started\" if started. type string The type of the Directory Connector."
        },
        {
          "name": "syncStatus",
          "description": "string The status of the directory synchronization process: \"started\" if started."
        },
        {
          "name": "type",
          "description": "string The type of the Directory Connector."
        },
        {
          "name": "fail",
          "description": "array expand_less"
        },
        {
          "name": "object expand_less errors array expand_less object expand_more key object The request item associated with this error",
          "description": "errors array expand_less object expand_more key object The request item associated with this error"
        },
        {
          "name": "errors",
          "description": "array expand_less"
        },
        {
          "name": "object expand_more",
          "description": ""
        },
        {
          "name": "key",
          "description": "object The request item associated with this error"
        },
        {
          "name": "syncStatus",
          "description": "string The status of the directory synchronization process: \"started\" if started."
        },
        {
          "name": "type",
          "description": "string The type of the Directory Connector."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/execute-sync/post",
      "last_updated": "2025-12-12T14:51:37.058088+00:00"
    },
    {
      "id": "find-groups",
      "name": "Find Groups",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/find-groups",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/find-groups/post",
      "last_updated": "2025-12-12T14:51:38.324327+00:00"
    },
    {
      "id": "get-connection",
      "name": "Get Connection",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/get-connection",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/get-connection/post",
      "last_updated": "2025-12-12T14:51:39.604699+00:00"
    },
    {
      "id": "get-group-members",
      "name": "Get Group Members",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/get-group-members",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/get-group-members/post",
      "last_updated": "2025-12-12T14:51:40.874966+00:00"
    },
    {
      "id": "remove-group-member",
      "name": "Remove Group Member",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/remove-group-member",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/remove-group-member/post",
      "last_updated": "2025-12-12T14:51:42.173686+00:00"
    },
    {
      "id": "update-group",
      "name": "Update Group",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/directory/update-group",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/directory/update-group/post",
      "last_updated": "2025-12-12T14:51:44.410004+00:00"
    },
    {
      "id": "add-delegate-user",
      "name": "Add Delegate User",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/add-delegate-user",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/add-delegate-user/post",
      "last_updated": "2025-12-12T14:51:45.691481+00:00"
    },
    {
      "id": "add-to-purge-list",
      "name": "Add To Purge List",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/add-to-purge-list",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/add-to-purge-list/post",
      "last_updated": "2025-12-12T14:51:46.938880+00:00"
    },
    {
      "id": "create-user",
      "name": "Create User",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/create-user",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/create-user/post",
      "last_updated": "2025-12-12T14:51:48.589469+00:00"
    },
    {
      "id": "find-delegate-users",
      "name": "Find Delegate Users",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/find-delegate-users",
      "description": "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 . 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 Mimecaster Central Mimecaster Central .",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less primaryAddress (required) string The primary email address of the user that has delegate rights to another user.",
          "description": "primaryAddress (required) string The primary email address of the user that has delegate rights to another user."
        },
        {
          "name": "primaryAddress (required)",
          "description": "string The primary email address of the user that has delegate rights to another user."
        },
        {
          "name": "primaryAddress (required)",
          "description": "string The primary email address of the user that has delegate rights to another user."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/find-delegate-users/post",
      "last_updated": "2025-12-12T14:51:50.809935+00:00"
    },
    {
      "id": "get-aliases",
      "name": "Get Aliases",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/get-aliases",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/get-aliases/post",
      "last_updated": "2025-12-12T14:51:52.122838+00:00"
    },
    {
      "id": "get-attributes",
      "name": "Get Attributes",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/get-attributes",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/get-attributes/post",
      "last_updated": "2025-12-12T14:51:53.397016+00:00"
    },
    {
      "id": "get-import-status",
      "name": "Get Import Status",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/get-import-status",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/get-import-status/post",
      "last_updated": "2025-12-12T14:51:54.644999+00:00"
    },
    {
      "id": "get-internal-users",
      "name": "Get Internal Users",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/get-internal-users",
      "description": "Description This endpoint can be used to retrieve all internal users for a given domain. This endpoint can be used to retrieve all internal users for a given domain.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain at most 1 item"
        },
        {
          "name": "object expand_less domain string The parent domain to return users for.",
          "description": "domain string The parent domain to return users for."
        },
        {
          "name": "domain",
          "description": "string The parent domain to return users for."
        },
        {
          "name": "domain",
          "description": "string The parent domain to return users for."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/get-internal-users/post",
      "last_updated": "2025-12-12T14:51:55.936684+00:00"
    },
    {
      "id": "get-most-used-contacts",
      "name": "Get Most Used Contacts",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/get-most-used-contacts",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/get-most-used-contacts/post",
      "last_updated": "2025-12-12T14:51:57.191931+00:00"
    },
    {
      "id": "import-users",
      "name": "Import Users",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/import-users",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/import-users/post",
      "last_updated": "2025-12-12T14:51:58.474992+00:00"
    },
    {
      "id": "remove-alias",
      "name": "Remove Alias",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/remove-alias",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/remove-alias/post",
      "last_updated": "2025-12-12T14:51:59.767998+00:00"
    },
    {
      "id": "remove-delegate-user",
      "name": "Remove Delegate User",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/remove-delegate-user",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/remove-delegate-user/post",
      "last_updated": "2025-12-12T14:52:01.066721+00:00"
    },
    {
      "id": "remove-from-purge-list",
      "name": "Remove From Purge List",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/remove-from-purge-list",
      "description": "Description This endpoint can be used to remove internal or external users from the Purge List in case you added them by accident. This endpoint can be used to remove internal or external users from the Purge List in case you added them by accident.",
      "parameters": [
        {
          "name": "data",
          "description": "array expand_less must contain  exactly 1 item"
        },
        {
          "name": "object expand_less emailAddresses (required) array An array of strings containing the email addresses you want to remove from the Purge List. Maximum number of entries is 1000.",
          "description": "emailAddresses (required) array An array of strings containing the email addresses you want to remove from the Purge List. Maximum number of entries is 1000."
        },
        {
          "name": "emailAddresses (required)",
          "description": "array An array of strings containing the email addresses you want to remove from the Purge List. Maximum number of entries is 1000."
        },
        {
          "name": "emailAddresses (required)",
          "description": "array An array of strings containing the email addresses you want to remove from the Purge List. Maximum number of entries is 1000."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/remove-from-purge-list/post",
      "last_updated": "2025-12-12T14:52:02.480282+00:00"
    },
    {
      "id": "update-alias",
      "name": "Update Alias",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/update-alias",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/update-alias/post",
      "last_updated": "2025-12-12T14:52:03.734226+00:00"
    },
    {
      "id": "update-attributes",
      "name": "Update Attributes",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/update-attributes",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/update-attributes/post",
      "last_updated": "2025-12-12T14:52:04.990920+00:00"
    },
    {
      "id": "update-user",
      "name": "Update User",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/api/user/update-user",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api/user/update-user/post",
      "last_updated": "2025-12-12T14:52:06.275910+00:00"
    },
    {
      "id": "groups",
      "name": "Groups",
      "category": "User and Group Management",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/groups",
      "description": "Description This endpoint can be used to find groups that exist on a tenant. This endpoint can be used to find groups that exist on a tenant.",
      "parameters": [
        {
          "name": "source",
          "description": "string The following values are allowed: cloud, ldap The type of the folder source"
        },
        {
          "name": "query",
          "description": "string Query string that is used to filter the groups by description"
        },
        {
          "name": "pageSize",
          "description": "integer (int32) 1 \u2264 value \u2264 100 The maximum number of rows to return per page."
        },
        {
          "name": "pageToken",
          "description": "Example open_in_new NDY6bnVsbA== NDY6bnVsbA== content_copy string Pagination page token"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/groups/get",
      "last_updated": "2025-12-12T14:52:07.565471+00:00"
    },
    {
      "id": "groups",
      "name": "Groups",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/groups",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/groups/post",
      "last_updated": "2025-12-12T14:52:08.805543+00:00"
    },
    {
      "id": "{group_id}",
      "name": "{Group_Id}",
      "category": "User and Group Management",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/groups/{group_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/groups/%7Bgroup_id%7D/get",
      "last_updated": "2025-12-12T14:52:10.066636+00:00"
    },
    {
      "id": "members",
      "name": "Members",
      "category": "User and Group Management",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/groups/{group_id}/members",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/groups/%7Bgroup_id%7D/members/get",
      "last_updated": "2025-12-12T14:52:11.320393+00:00"
    },
    {
      "id": "members",
      "name": "Members",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/groups/{group_id}/members",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/groups/%7Bgroup_id%7D/members/post",
      "last_updated": "2025-12-12T14:52:12.578681+00:00"
    },
    {
      "id": "remove-members",
      "name": "Remove Members",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/groups/{group_id}/remove-members",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/groups/%7Bgroup_id%7D/remove-members/post",
      "last_updated": "2025-12-12T14:52:13.940453+00:00"
    },
    {
      "id": "integrations",
      "name": "Integrations",
      "category": "User and Group Management",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/integrations",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/get",
      "last_updated": "2025-12-12T14:52:15.272002+00:00"
    },
    {
      "id": "active-directory",
      "name": "Active Directory",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/post",
      "last_updated": "2025-12-12T14:52:16.524680+00:00"
    },
    {
      "id": "{integration_id}",
      "name": "{Integration_Id}",
      "category": "User and Group Management",
      "method": "GET",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}",
      "description": "Description Gets an Active Directory directory integration. Gets an Active Directory directory integration.",
      "parameters": [
        {
          "name": "integration_id (required)",
          "description": "string ID of the Active Directory integration to get"
        },
        {
          "name": "enabled",
          "description": "boolean Whether integration is enabled or disabled."
        },
        {
          "name": "description",
          "description": "string The description of the integration. length  \u2264 120"
        },
        {
          "name": "info",
          "description": "string Additional info about the active directory integration. length  \u2264 240"
        },
        {
          "name": "hostname",
          "description": "string Server name - IP address or host/domain name."
        },
        {
          "name": "alternateHostname",
          "description": "string Alternate server name - IP address or host/domain name."
        },
        {
          "name": "port",
          "description": "integer The port number the integration should use to communicate on. 1 \u2264 value \u2264 65535"
        },
        {
          "name": "userDn",
          "description": "string User distinguished name e.g. CN=User, CN=Users, DC=companyname, DC=com."
        },
        {
          "name": "rootDn",
          "description": "string Root distinguished name - CN=User, CN=Users, DC=companyname, DC=com."
        },
        {
          "name": "encryptionMode",
          "description": "string The mode of encryption set on the connector - none, strict, relaxed. The following values are allowed: relaxed, strict, none"
        },
        {
          "name": "status",
          "description": "string Status of the integration - ok, not_active, error. The following values are allowed: ok, not_active, error"
        },
        {
          "name": "lastSyncDateTime",
          "description": "string (date-time) Time of the last sync made using this connector. Format yyyy-MM-dd'T'HH:mm:ssZ."
        },
        {
          "name": "syncRunning",
          "description": "boolean Whether sync is running for this integration."
        },
        {
          "name": "domains",
          "description": "array List the domains the Directory Connector will synchronize details with (Optional)."
        },
        {
          "name": "acknowledgeDisabledAccounts",
          "description": "boolean Acknowledge disabled accounts in AD."
        },
        {
          "name": "maxUnlink",
          "description": "integer Max unlink count."
        },
        {
          "name": "syncContacts",
          "description": "boolean Sync contacts."
        },
        {
          "name": "deleteUsers",
          "description": "boolean Delete users."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/get",
      "last_updated": "2025-12-12T14:52:19.870912+00:00"
    },
    {
      "id": "{integration_id}",
      "name": "{Integration_Id}",
      "category": "User and Group Management",
      "method": "PATCH",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/patch",
      "last_updated": "2025-12-12T14:52:21.140280+00:00"
    },
    {
      "id": "{integration_id}",
      "name": "{Integration_Id}",
      "category": "User and Group Management",
      "method": "DELETE",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}",
      "description": "Description Deletes an Active Directory directory integration. Deletes an Active Directory directory integration.",
      "parameters": [
        {
          "name": "integration_id (required)",
          "description": "string ID of the Active Directory integration to delete"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/delete",
      "last_updated": "2025-12-12T14:52:22.453052+00:00"
    },
    {
      "id": "test-authentication",
      "name": "Test Authentication",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-authentication",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-authentication/post",
      "last_updated": "2025-12-12T14:52:23.709705+00:00"
    },
    {
      "id": "test-certificates",
      "name": "Test Certificates",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-certificates",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-certificates/post",
      "last_updated": "2025-12-12T14:52:24.965216+00:00"
    },
    {
      "id": "test-connectivity",
      "name": "Test Connectivity",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-connectivity",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-connectivity/post",
      "last_updated": "2025-12-12T14:52:26.238077+00:00"
    },
    {
      "id": "test-egress-connectivity",
      "name": "Test Egress Connectivity",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-egress-connectivity",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-egress-connectivity/post",
      "last_updated": "2025-12-12T14:52:27.491954+00:00"
    },
    {
      "id": "test-email",
      "name": "Test Email",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-email",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-email/post",
      "last_updated": "2025-12-12T14:52:28.772252+00:00"
    },
    {
      "id": "test-validation",
      "name": "Test Validation",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/active-directory/{integration_id}/test-validation",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/active-directory/%7Bintegration_id%7D/test-validation/post",
      "last_updated": "2025-12-12T14:52:30.041168+00:00"
    },
    {
      "id": "google",
      "name": "Google",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/google",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/google/post",
      "last_updated": "2025-12-12T14:52:31.340689+00:00"
    },
    {
      "id": "test-authorisation",
      "name": "Test Authorisation",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/google/{integration_id}/test-authorisation",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/google/%7Bintegration_id%7D/test-authorisation/post",
      "last_updated": "2025-12-12T14:52:38.360176+00:00"
    },
    {
      "id": "m365",
      "name": "M365",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/m365",
      "description": "Description Creates a new directory integration for M365. Creates a new directory integration for M365.",
      "parameters": [
        {
          "name": "description",
          "description": "string The description of the integration. length  \u2264 120"
        },
        {
          "name": "info",
          "description": "string Additional info about the active directory integration. length  \u2264 240"
        },
        {
          "name": "domains",
          "description": "array List the domains the Directory Connector will synchronize details with (Optional)."
        },
        {
          "name": "connectorId",
          "description": "string Cloud Connector ID. More Details on using consent api to create Microsoft Azure or Microsoft Azure GCC High Directory Integration can be found here"
        },
        {
          "name": "tenantDomain",
          "description": "string The tenant domain used when signing up to Office 365."
        },
        {
          "name": "serverSubtype",
          "description": "string The subtype of the Office 365 server - standard or gov. Default is standard. The following values are allowed: standard, gov"
        },
        {
          "name": "syncGuestUsers",
          "description": "boolean Sync Azure guest users."
        },
        {
          "name": "acknowledgeDisabledAccounts",
          "description": "boolean Acknowledge disabled accounts."
        },
        {
          "name": "enabled",
          "description": "boolean Whether integration is enabled or disabled."
        },
        {
          "name": "maxUnlink",
          "description": "string Max unlink count. The following values are allowed: 0, 10, 20, 50, 100, 300, 500, 1,000, 2,000, 5,000, 10,000, 50,000, 100,000, unlimited Default value \"10\""
        },
        {
          "name": "syncContacts",
          "description": "boolean Sync contacts."
        },
        {
          "name": "deleteUsers",
          "description": "boolean Delete users."
        },
        {
          "name": "id",
          "description": "string ID of entity."
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/m365/post",
      "last_updated": "2025-12-12T14:52:42.346975+00:00"
    },
    {
      "id": "test-connector",
      "name": "Test Connector",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/m365/{integration_id}/test-connector",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/m365/%7Bintegration_id%7D/test-connector/post",
      "last_updated": "2025-12-12T14:52:51.377871+00:00"
    },
    {
      "id": "sync-requests",
      "name": "Sync Requests",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/directory/cloud-gateway/v1/integrations/sync-requests",
      "description": "Description Requests a sync of all directory integrations for account. Requests a sync of all directory integrations for account.",
      "parameters": [
        {
          "name": "action (required)",
          "description": "string The action to take (may only be \"start\") The following values are allowed: start"
        },
        {
          "name": "status",
          "description": "string Status of the directory sync. The following values are allowed: sync_requested, already_in_progress, no_integrations_enabled"
        },
        {
          "name": "mseStatus",
          "description": "string Status of the MSE sync. Null if the customer doesn't have MSE connections. The following values are allowed: mse_sync_skipped, mse_sync_requested, mse_sync_server_offline, mse_sync_server_upgrade, mse_sync_server_inactive"
        }
      ],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/directory/cloud-gateway/v1/integrations/sync-requests/post",
      "last_updated": "2025-12-12T14:52:55.064814+00:00"
    },
    {
      "id": "users",
      "name": "Users",
      "category": "User and Group Management",
      "method": "GET",
      "path": "/user/cloud-gateway/v1/users",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/user/cloud-gateway/v1/users/get",
      "last_updated": "2025-12-12T14:52:56.339656+00:00"
    },
    {
      "id": "users",
      "name": "Users",
      "category": "User and Group Management",
      "method": "POST",
      "path": "/user/cloud-gateway/v1/users",
      "description": null,
      "parameters": [],
      "url": "https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/user/cloud-gateway/v1/users/post",
      "last_updated": "2025-12-12T14:52:57.651706+00:00"
    }
  ]
}