This endpoint can be used to find existing Anti-Spoofing SPF based Bypass policies.
Pre-requisites
In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Gateway | Policies | Read permission.
URI
To use this endpoint you send a POST request to:
/api/policy/antispoofing-bypass/get-policy
Request Headers
The following request headers must be included in your request:
Field
Description
Authorization
Please see the Authorization guide for more information on building the Authorization header.
x-mc-req-id
A randomly generated GUID, for example,
8578FCFC-A305-4D9A-99CB-F4D5ECEFE297
x-mc-app-id
The Application ID provided with your Registered API Application.
x-mc-date
The current date and time in the following format, for example,
Tue, 24 Nov 2015 12:50:11 UTC
Request Body
{
"data": [
{
"id": "String"
}
]
}
meta
Field
Type
Required
Description
pagination
Object
Optional
An object defining paging options for the request.
Paginiation Object
Field
Type
Required
Description
pageSize
Number
Optional
The number of results to request.
pageToken
String
Optional
The value of the 'next' or 'previous' fields from an earlier request.
data
Field
Type
Required
Description
id
String
Optional
The Mimecast secure id of an existing policy. Omit this field to obtain all policies.
Response
{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"policy": [
{
"fromEternal": true,
"toDate": "Date String",
"enforced": false,
"from": {
"attribute": {
"name": "String",
"value": "String",
"id": "String"
},
"group": {
"folders": [
"String"
],
"description": "String",
"source": "String",
"folderCount": 100,
"parentId": "String",
"id": "String",
"userCount": 100
},
"type": "String",
"emailAddress": "String",
"emailDomain": "String"
},
"description": "String",
"enabled": false,
"fromValue": "String",
"comment": "String",
"fromType": "String",
"to": {
"attribute": {
"name": "String",
"value": "String",
"id": "String"
},
"group": {
"folders": [
"String"
],
"description": "String",
"source": "String",
"folderCount": 100,
"parentId": "String",
"id": "String",
"userCount": 100
},
"type": "String",
"emailAddress": "String",
"emailDomain": "String"
},
"fromDate": "Date String",
"lastUpdated": "Date String",
"override": false,
"bidirectional": false,
"toEternal": true,
"conditions": {
"sourceIPs": [
"String"
]
},
"createTime": "Date String",
"fromPart": "String"
}
],
"id": "String",
"option": "String"
}
]
}
meta object
Field
Type
Description
status
Number
The function level status of the request.
pagination
Object
An object containing paging information.
Pagination object
Field
Type
Description
pageSize
Number
The number of results requested.
next
String
A pageToken value that can be used to request the next page of results. Only returned if there are more results to return.
previous
String
A pageToken value that can be used to request the previous page of results. Only returned if there is a previous page.
meta
Field
Type
Description
status
Number
The function level status of the request.
data
Field
Type
Description
option
String
The action taken by a policy.
id
String
The Mimecast secure id of the Address Alteration Set (folder) that will be applied by this policy
policy
Policy Details Object
An object of conditions that determine when to apply the alteration set
Policy Details Object
Field
Type
Description
enforced
Boolean
Is the policy enforced
bidirectional
String
Should the policy also apply in reverse email flow of the definied by this policy
toDate
Date String
The end date that the policy should cease to apply in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
description
String
The description for the policy (name)
toEternal
Boolean
Should the policy continue to apply, regardless of the current date and time
enabled
Boolean
Should the policy be considered for emails processing through Mimecast
fromDate
Date String
The start date that the policy should begin to apply in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
fromPart
String
Should the sender address be considered based on the envelope, header or either address
fromEternal
Boolean
Should the policy start to apply, regardless of the current date and time
fromType
String
The sender address type (e.g. envelope or header). Will be envelope_from, header_from or both.
fromValue
String
The value that the sender address will be compared against
from
Policy Target Object
Scope of application based on the sender address
toType
String
The component of the recipient address object that this policy should be scoped
toValue
String
The value that the recipient address will be compared against
to
Policy Target Object
Scope of application based on the recipient address
override
Boolean
Should the policy be considered for application, and apply if conditions met, prior to other policies of the same type
conditions
Policy Conditions Object
Conditions of the sending platform to determine if the policy should be considered
createTime
Date String
The creation timestamp of the policy in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
lastUpdated
String
The most recent modification timestamp of the policy in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000)
Policy Target Object
Field
Type
Description
emailAddress
String
The email address to apply the policy based on
emailDomain
String
The email domain to apply the policy based on
group
Group Object
The group to which the policy is scoped
attribute
Attribute Object
The address object attribute to apply this policy based on
type
String
The component of the address object that this policy should be scoped
Attribute Object
Field
Type
Description
name
String
The name of the user address attribute to compare value
id
String
The Mimecast secure id of the user address attribute
value
String
The value to which the user address attribute should equal
Policy Conditions Object
Field
Type
Description
spfDomains
Array of Strings
An array of SPF records to reference when checking the source IP address
Group Object
Field
Type
Description
folders
Array of Group Objects
An array of all sub-groups for the current group.
userCount
Number
The number of users in the current group.
description
String
The name of the current group.
id
String
The Mimecast secure id of the current group.
source
String
The source of the current group. Will be cloud or ldap.
folderCount
Number
The number of sub-groups within the current group.
parentId
String
The Mimecast secure id of the parent group.
Sample Code
Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE. Please see the Global Base URL's page to find the correct base URL to use for your account.
POST {base_url}/api/policy/antispoofing-bypass/get-policy
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
x-mc-date: {dateTime}
x-mc-req-id: {unique id}
x-mc-app-id: {applicationId}
Content-Type: application/json
Accept: application/json
{
"data":[
{
"id": "String"
}
]
}
import base64
import hashlib
import hmac
import uuid
import datetime
import requests
# Setup required variables
base_url = "https://xx-api.mimecast.com"
uri = "/api/policy/antispoofing-bypass/get-policy"