In this guide:
Pre-requisites
- In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Accounts | Dashboard | Read permission.
URI
To use this endpoint you send a POST request to:
- /api/account/get-account
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,
|
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,
|
Request Body
{ "data": [] }
Response
{ "fail": [], "meta": { "status": 200 }, "data": [ { "maxRetention": 30, "accountCode": "String", "domain": "String", "automatedSegmentPurge": false, "databaseCode": "String", "supportCode": "String", "region": "String", "accountName": "String", "maxRetentionConfirmed": false, "archive": false, "gateway": true, "policyInheritance": false, "passphrase": "String", "type": "String", "mailPlatform": "String", "packages": [ "String" ], "mimecastId": "String", "adminEmail": "String", "userCount": 20 } ] }
meta object
Field | Type | Description |
---|---|---|
status | Number | The function level status of the request. |
data
Field | Type | Description |
---|---|---|
maxRetention | Number | The maximum retention in days configured for the account. |
accountCode | String | The unique Mimecast account code for the customer. |
domain | 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 packages enabled on the customer account. |
accountName | String | The account name. |
automatedSegmentPurge | Boolean | If purging of expired storage segments is enabled on the account. |
databaseCode | String | The database code. |
supportCode | String | The support code for the account. |
region | String | The region where the account is hosted. |
adminEmail | String | The email address of the first administrator created on the account. |
gateway | Boolean | If gateway features are enabled on the account. |
mimecastId | String | The unique Mimecast ID of the account. |
mailPlatform | String | The mail platform defined for the account. |
passphrase | String | The passphrase set on the acocunt. used by Mimecast Support when verifying callers during support calls. |
type | String | The type of account. |
policyInheritance | Boolean | If policy inheritance is enabled on the account. |
maxRetentionConfirmed | Boolean | If the maximum retention value on the account has been confirmed. |
archive | Boolean | If gateway features are enabled on the account. |
userCount | Number | The number of user licences on the 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/get-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":[ ] }