Create Account

As an authorized Mimecast Managed Service Provider, create a new Mimecast customer account.

Pre-requisites

  • To use this endpoint the requesting user must be a member of the Partner Provisioning Role.

Prior to using this endpoint please contact your Partner Account Manager to ensure that your Mimecast account and records are properly setup to support this use case.

URI

To use this endpoint you send a POST request to:

  • /api/account/create-account

Request Headers

The following request headers must be included in your request:

FieldDescription
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": [
  {
   "city": "String", 
   "umbrellaAccounts": [
    "String"
   ], 
   "adminPassword": "String", 
   "country": "String", 
   "forcePasswordChange": false, 
   "companyRegistrationNumber": "String", 
   "telephone": "String", 
   "accountName": "String", 
   "contactEmail": "String", 
   "adminRole": "String", 
   "state": "String", 
   "mailPlatform": "String", 
   "contactName": "String", 
   "addressLine1": "String", 
   "postalCode": "String", 
   "products": [
    9702
   ], 
   "primaryDomain": "String", 
   "maximumRetention": 180, 
   "numberOfUsers": 100
  }
 ]
}
data
FieldTypeRequiredDescription
accountName String Required The account name for the new customer.
addressLine1 String Required The address of the new customer.
country String Required The country of the new customer's address. Must be a short code of a country that Mimecast is authorized to operate in. Please see the Country Codes page for allowed values.
city String Required The city of the new customer's address.
state String Required The state of the new customer's address. Please see the State Codes page for allowed values.
postalCode String Required The zip / post code of the new customer's address.
companyRegistrationNumber String Required The registration number of the new customer.
maximumRetention Number Required The number of days of archive retention that should be defined on the new account (maximum of 999999).
contactEmail String Required The email address of the primary contact for the new customer.
contactName String Required The name of the primary contact for the new customer.
telephone String Required The telephone number of the primary contact for the new customer.
numberOfUsers Number Required The number of actual users that the new customer has. Not necessarily the number of email addresses. This is the number that will be used for billing purposes.
estimatedUserCount Number Optional Use this if you cannot set the actual value for the numberOfUsers field. It is used to dynamically allocate you the best spot on the Mimecast grid.
adminRole String Optional The level of access that the first administrator created should have to the new account. Must be one of: basic_admin, full_admin.
adminPassword String Required The password that should be set for the first Administrator created on the new account. By default the Force Change at Logon setting will be enabled.
forcePasswordChange Boolean Optional Default true. Add this parameter if you want to override this setting to false.
primaryDomain String Optional The primary domain associated with the account. This is for visual purposes only and does not register the domain with Mimecast.
mailPlatform String Optional Defines the customers mail environment in order to drive the correct workflow in the Mimecast Connect Application. Must be one of: "office_365", "on_premises", "hosted_exchange".
umbrellaAccounts Array Optional An array of strings representing the Mimecast account codes you want to use as the umbrella account(s) for the new customer account. An umbrella account is used to store all of the Authorized Outbound IP addresses that your customer accounts will use to send outbound email. Using an umbrella account means that you only have to set this up once rather than contacting Mimecast Service Delivery each and every time you create a new customer account.
products Array Required An array of product ID's for the Mimecast products that should be enabled for the new customer. Each partner will have different agreements with Mimecast. Use the /api/provisioning/get-packages endpoint to discover the product ID's that you are authorized to provision.

Response

{
 "fail": [], 
 "meta": {
  "status": 200
 }, 
 "data": [
  {
   "accountCode": "String", 
   "domain": "String", 
   "packages": [
    "String"
   ], 
   "adminEmail": "String"
  }
 ]
}
meta object
FieldTypeDescription
status Number The function level status of the request.
data
FieldTypeDescription
accountCode String The unique Account Code for the new account.
adminEmail String The email address of the first Administrator created on the new account.
doamin String The temporary domain name added to the account. This name is generated by Mimecast and is only used for initial access to the account. It should not be used for mail routing.
packages Array An array of Mimecast packages enabled on the new account.

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/account/create-account
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":[
      {
          "accountName": "String",
          "addressLine1": "String",
          "country": "String",
          "city": "String",
          "state": "String",
          "postalCode": "String",
          "companyRegistrationNumber": "String",
          "maximumRetention": 180,
          "contactEmail": "String",
          "contactName": "String",
          "telephone": "String",
          "numberOfUsers": 100,
          "adminRole": "String",
          "adminPassword": "String",
          "forcePasswordChange": False,
          "primaryDomain": "String",
          "mailPlatform": "String",
          "umbrellaAccounts": [
            "String"
          ],
          "products": [
            9702
          ]
      }
  ]
}
import base64
import hashlib
import hmac
import uuid
import datetime
import requests

# Setup required variables
base_url = "https://xx-api.mimecast.com"
uri = "/api/account/create-account"
url = base_url + uri
access_key = "YOUR ACCESS KEY"
secret_key = "YOUR SECRET KEY"
app_id = "YOUR APPLICATION ID"
app_key = "YOUR APPLICATION KEY"

# Generate request header values
request_id = str(uuid.uuid4())
hdr_date = datetime.datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S") + " UTC"

# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 = hmac.new(secret_key.decode("base64"), ':'.join([hdr_date, request_id, uri, app_key]),
                  digestmod=hashlib.sha1).digest()

# Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
sig = base64.encodestring(hmac_sha1).rstrip()

# Create request headers
headers = {
    'Authorization': 'MC ' + access_key + ':' + sig,
    'x-mc-app-id': app_id,
    'x-mc-date': hdr_date,
    'x-mc-req-id': request_id,
    'Content-Type': 'application/json'
}

payload = {
        'data': [
            {
                "accountName": "String",
                "addressLine1": "String",
                "country": "String",
                "city": "String",
                "state": "String",
                "postalCode": "String",
                "companyRegistrationNumber": "String",
                "contactEmail": "String",
                "contactName": "String",
                "telephone": "String",
                "numberOfUsers": 10,
                "adminPassword": "String",
                "forcePasswordChange": False,
                "mailPlatform": "String",
                "maximumRetention": 30
                "umbrellaAccounts": [
                    "String"
                ],
                "products": [
                    9702
                ]
            }
        ]
    }

r = requests.post(url=url, headers=headers, data=str(payload))

print r.text
static void Main(string[] args)
        {
            //Setup required variables
            string baseUrl = "https://xx-api.mimecast.com";
            string uri = "/api/account/create-account";
            string accessKey = "YOUR ACCESS KEY";
            string secretKey = "YOUR SECRET KEY";
            string appId = "YOUR APPLICATION ID";
            string appKey = "YOUR APPLICATION KEY";

            //Generate request header values
            string hdrDate = System.DateTime.Now.ToUniversalTime().ToString("R");
            string requestId = System.Guid.NewGuid().ToString();

            //Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
            System.Security.Cryptography.HMAC h = new System.Security.Cryptography.HMACSHA1(System.Convert.FromBase64String(secretKey));

            //Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
            byte[] hash = h.ComputeHash(System.Text.Encoding.Default.GetBytes(hdrDate + ":" + requestId + ":" + uri + ":" + appKey));

            //Build the signature to be included in the Authorization header in your request
            string signature = "MC " + accessKey + ":" + System.Convert.ToBase64String(hash);

            //Build Request
            System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(baseUrl + uri);
            request.Method = "POST";
            request.ContentType = "application/json";

            //Add Headers
            request.Headers[System.Net.HttpRequestHeader.Authorization] = signature;
            request.Headers.Add("x-mc-date", hdrDate);
            request.Headers.Add("x-mc-req-id", requestId);
            request.Headers.Add("x-mc-app-id", appId);

            //Add request body
            //Create and write data to stream
            string postData = @"{
                    ""data"": [
                        {
                            ""accountName"": ""String"",
                            ""addressLine1"": ""String"",
                            ""country"": ""String"",
                            ""city"": ""String"",
                            ""state"": ""String"",
                            ""postalCode"": ""String"",
                            ""companyRegistrationNumber"": ""String"",
                            ""contactEmail"": ""String"",
                            ""contactName"": ""String"",
                            ""telephone"": ""String"",
                            ""numberOfUsers"": 10,
                            ""adminPassword"": ""String"",
                            ""forcePasswordChange"": False,
                            ""mailPlatform"": ""String"",
                            ""maximumRetention"": 30
                            ""umbrellaAccounts"": [
                                ""String""
                            ],
                            ""products"": [
                                9702
                            ]
                        }
                    ]
                }";

            byte[] payload = System.Text.Encoding.UTF8.GetBytes(postData);

            System.IO.Stream stream = request.GetRequestStream();
            stream.Write(payload, 0, payload.Length);
            stream.Close();

            //Send Request
            System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();

            //Output response to console
            System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
            string responseBody = "";
            string temp = null;
            while ((temp = reader.ReadLine()) != null)
            {
                responseBody += temp;
            };
            System.Console.WriteLine(responseBody);
            System.Console.ReadLine();
        }
#Setup required variables
$baseUrl = "https://xx-api.mimecast.com"
$uri = "/api/account/create-account"
$url = $baseUrl + $uri
$accessKey = "YOUR ACCESS KEY"
$secretKey = "YOUR SECRET KEY"
$appId = "YOUR APPLICATION ID"
$appKey = "YOUR APPLICATION KEY"

#Generate request header values
$hdrDate = (Get-Date).ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss UTC")
$requestId = [guid]::NewGuid().guid

#Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
$sha = New-Object System.Security.Cryptography.HMACSHA1
$sha.key = [Convert]::FromBase64String($secretKey)
$sig = $sha.ComputeHash([Text.Encoding]::UTF8.GetBytes($hdrDate + ":" + $requestId + ":" + $uri + ":" + $appKey))
$sig = [Convert]::ToBase64String($sig)

#Create Headers
$headers = @{"Authorization" = "MC " + $accessKey + ":" + $sig;
                "x-mc-date" = $hdrDate;
                "x-mc-app-id" = $appId;
                "x-mc-req-id" = $requestId;
                "Content-Type" = "application/json"}

#Create post body
$postBody = "{
                    ""data"": [
                        {
                            ""accountName"": ""String"",
                            ""addressLine1"": ""String"",
                            ""country"": ""String"",
                            ""city"": ""String"",
                            ""state"": ""String"",
                            ""postalCode"": ""String"",
                            ""companyRegistrationNumber"": ""String"",
                            ""contactEmail"": ""String"",
                            ""contactName"": ""String"",
                            ""telephone"": ""String"",
                            ""numberOfUsers"": 10,
                            ""adminPassword"": ""String"",
                            ""forcePasswordChange"": False,
                            ""mailPlatform"": ""String"",
                            ""maximumRetention"": 30,
                            ""umbrellaAccounts"": [
                                ""String""
                            ],
                            ""products"": [
                                9702
                            ]
                        }
                    ]
                }"

#Send Request
$response = Invoke-RestMethod -Method Post -Headers $headers -Body $postBody -Uri $url

#Print the response
$response
public static void main(String[] args) throws java.io.IOException, java.security.NoSuchAlgorithmException, java.security.InvalidKeyException {

        //set up variables for request
        String baseUrl = "https://xx-api.mimecast.com";
        String uri = "/api/account/create-account";
        String url = "https://" + baseUrl + uri;
        String accessKey = "YOUR ACCESS KEY";
        String secretKey = "YOUR SECRET KEY";
        String appId = "YOUR APPLICATION ID";
        String appKey = "YOUR APPLICATION KEY";

        //create URL object
        java.net.URL obj = new java.net.URL(url);

        // set guid for x-mc-req-id header
        String guid = java.util.UUID.randomUUID().toString();

        // set date for x-mc-date header
        java.text.SimpleDateFormat sdf = new java.text.SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss z");
        sdf.setTimeZone(java.util.TimeZone.getTimeZone("UTC"));
        String date = sdf.format(new java.util.Date());

        //create signature for the Authorization header
        String dataToSign = date + ":" + guid + ":" + uri + ":" + appKey;
        String hmacSHA1 = "HmacSHA1";
        javax.crypto.spec.SecretKeySpec signingKey = new javax.crypto.spec.SecretKeySpec(org.apache.commons.codec.binary.Base64.decodeBase64(secretKey.getBytes()), hmacSHA1);
        javax.crypto.Mac mac = javax.crypto.Mac.getInstance(hmacSHA1);
        mac.init(signingKey);
        String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));

        // create request object
        javax.net.ssl.HttpsURLConnection con = (javax.net.ssl.HttpsURLConnection) obj.openConnection();

        //set request type to POST
        con.setRequestMethod("POST");
        con.setDoOutput(true);

        //add reuqest headers
        con.setRequestProperty("Authorization", "MC " + accessKey + ":" + sig);
        con.setRequestProperty("x-mc-req-id", guid);
        con.setRequestProperty("x-mc-app-id", appId);
        con.setRequestProperty("x-mc-date", date);
        con.setRequestProperty("Content-Type", "application/json");
        con.setRequestProperty("Accept", "application/json");

        //Add post body to the request
        String postBody = "{\n" +
        " \"data\": [\n" +
        "     {\n" +
        "         \"accountName\": \"String\",\n" +
        "         \"addressLine1\": \"String\",\n" +
        "         \"country\": \"String\",\n" +
        "         \"city\": \"String\",\n" +
        "         \"state\": \"String\",\n" +
        "         \"postalCode\": \"String\",\n" +
        "         \"companyRegistrationNumber\": \"String\",\n" +
        "         \"contactEmail\": \"String\",\n" +
        "         \"contactName\": \"String\",\n" +
        "         \"telephone\": \"String\",\n" +
        "         \"numberOfUsers\": 10,\n" +
        "         \"adminPassword\": \"String\",\n" +
        "         \"forcePasswordChange\": False,\n" +
        "         \"mailPlatform\": \"String\",\n" +
        "         \"maximumRetention\": 30,\n" +
        "         \"umbrellaAccounts\": [\"String\"],\n" +
        "         \"products\": [9702]\n" +
        "     }\n" +
        " ]\n" +
        "}";
        java.io.OutputStream os = con.getOutputStream();
        os.write(postBody.getBytes("UTF-8"));
        os.close();

        //process response
        java.io.BufferedReader in = new java.io.BufferedReader(
                new java.io.InputStreamReader(con.getInputStream()));
        String inputLine;
        StringBuffer response = new StringBuffer();

        while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
        }
        in.close();

        //return result
        java.lang.System.out.println(response.toString());
    }