The import users endpoint can be used to import users to an Internal Directory or a Profile Group.
Users are imported via file upload, using an XSLX, XLS or CSV file (a CSV-structured request body can also be used to perform a 'fileless' user import).
A list of available fields can be found in our Community KB. The import users endpoint also supports AAA accounts, to import users to specific mail-processing child accounts.
Note: If using the CSV file format, ensure your body ends with a new line character, to indicate the end of the file.
Pre-requisites
In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Directories | Import | Edit permission.
URI
To use this endpoint you send a POST request to:
/api/user/import-users
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
x-mc-arg
A JSON object containing an x-mc-arg Header Object
Structured similar to other API call request bodies, this endpoint should have a single data object within an array.
x-mc-arg Header data Object
Field
Type
Required
Description
notifyEmailAddress
String
Optional
Email address of a recpient to be notified when the user import has completed.
allowAddressMigration
Boolean
Optional
If using a AAA account structure, this option will allow the import to migrate the address from one account to another. If set to true, the user's accountCode value will be used as the target account. The default value is false.
groupId
String
Optional
The Mimecast secure ID of a Profile Group, to which the users should be added.
clearGroup
Boolean
Optional
If being used to add users to a group with a groupId, this option can be used to determine if the group should be cleared prior to making additions. The default value is false.
fileType
String
Optional
Specifies the file format of the data submitted in the request body. Must be one of CSV, XLS or XLSX. The default value is XLS.
Returns true if the import job has been successfully submitted.
id
String
The Mimecast secure ID of the import job.
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/user/import-users
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
*** user import file ***
import base64
import hashlib
import hmac
import uuid
import datetime
import requests
# Setup required variables
base_url = "https://xx-api.mimecast.com"
uri = "/api/user/import-users"
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"
# DataToSign is used in hmac_sha1
dataToSign = ':'.join([hdr_date, request_id, uri, app_key])
# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 = hmac.new(base64.b64decode(secret_key), dataToSign.encode(), digestmod=hashlib.sha1).digest()
# Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
sig = base64.b64encode(hmac_sha1).rstrip()
# Create request headers
headers = {
'Authorization': 'MC ' + access_key + ':' + sig.decode(),
'x-mc-app-id': app_id,
'x-mc-date': hdr_date,
'x-mc-req-id': request_id,
'x-mc-arg': '{"data":[{"notifyEmailAddress":"String","allowAddressMigration":true,"groupId":"String","clearGroup":false,"fileType":"csv"}]}',
'Content-Type': 'application/json'
}
payload = *** user import file ***
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/user/import-users";
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);
request.Headers.Add("x-mc-arg", ""{"data":[{"notifyEmailAddress":"String","allowAddressMigration":true,"groupId":"String","clearGroup":false,"fileType":"csv"}]}"");
//Add request body
//Create and write data to stream
string postData = *** user import file ***;
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();
}