This endpoint can be used to create new cloud-users in Mimecast's Internal Directories.
Pre-requisites
In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Directories | I | Edit permission.
URI
To use this endpoint you send a POST request to:
/api/user/create-user
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": [
{
"accountCode": "String",
"password": "String",
"emailAddress": "String",
"name": "String",
"forcePasswordChange": false
}
]
}
data
Field
Type
Required
Description
emailAddress
String
Required
The email address of the new user.
password
String
Optional
The Mimecast cloud password that should be set for the new user.
accountCode
String
Optional
The Mimecast account code that the new user should be created in.
forcePasswordChange
Boolean
Optional
If the user must change their password the next time they login.
name
String
Optional
The display name that should be set for the new user.
Response
{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"emailAddress": "String",
"id": "String"
}
]
}
meta object
Field
Type
Description
status
Number
The function level status of the request.
data
Field
Type
Description
id
String
The Mimecast secure id of the new user.
emailAddress
String
The new user's email address.
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/create-user
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}