Get Group Members

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Directories | Groups | Read permission.

URI

To use this endpoint you send a POST request to:

  • /api/directory/get-group-members

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 Required The Mimecast ID of the group to return. This value is returned by the /api/directory/get-group or /api/directory/find-groups endpoints

Response

{
"fail": [],
"meta": {
"status": 200,
"pagination": {
"pageSize": 25,
"next": "String"
}
},
"data": [
{
"groupMembers": [
{
"emailAddress": "String",
"domain": "String",
"internal": true,
"type": "String",
"name": "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.
data
Field Type Description
groupMembers Array An array of Group Member objects.
Group Member
Field Type Description
type String The type of user.
domain String The domain name of the user's email address.
internal Boolean If the user is internal or not.
emailAddress String The user's email address.
name String The user's display name.

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/directory/get-group-members
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"
}
]
}
Back to Top