Add group member

Adds a member to the specified group.

POST ~/api/directoryObjects/groupMembers

Request parameters

This request has no parameters.

Request headers

  • Name

  • Required

  • Description

  • Adm-Authorization

  • True

  • Specify the security token obtained during authentication.

  • Content-Type

  • True

  • Use application/json as the value of this header.

Request body

The request body is a JSON object with the following data structure:

{
    "group": "<groupId>",
    "newMember": "<memberId>"
}

group string
The identifier of the group to add a member to. A group can be identified by:

 Distinguished name (DN) {.black}
# Example
CN=My Group,CN=Groups,DC=example,DC=com
 Globally unique identifier (GUID) {.black}
# Example
a7b63270-b8a4-4c34-b830-7e0d09f2e021
 Security identifier (SID) {.black}
# Example
S-1-5-21-3625849556-2655411187-3268999566-9847

newMember string
The identifier of the directory object which should be added to the group. A directory object can be identified by:

 Distinguished name (DN) {.black}
# Example
CN=John Smith,CN=Users,DC=example,DC=com
 Globally unique identifier (GUID) {.black}
# Example
7a4267ce-d354-44e7-8bd6-c681f1284a41
 Security identifier (SID) {.black}
# Example
S-1-5-21-3635565734-1729062999-1822655016-1627

Responses

If successful, returns 200 OK status code and an operation result in the response body. Otherwise, returns one of the common HTTP error codes and an error description in the response body.

Examples

 Add a group member

The following code sample adds a user to the specified group.

Request

PowerShell
$memberIdentifier = "CN=John Smith,CN=Users,DC=example,DC=com"
$groupIdentifier = "CN=My Group,OU=Groups,DC=example,DC=com"

$baseUrl = "https://host.example.com/restApi"
$endpoint = "/api/directoryObjects/groupMembers"
$requestUrl = $baseUrl + $endpoint
$requestHeaders = @{"Adm-Authorization" = "HxtdAPz73OFfae7....w7lQvxjJHIbVqgkCtPtLD"}
$requestBody = ConvertTo-Json @{
    "group" = $groupIdentifier;
    "newMember" = $memberIdentifier
} 

# Make request
Invoke-RestMethod -Method POST -Headers $requestHeaders -Uri $requestUrl `
    -Body $requestBody -ContentType "application/json"
C#
using System;
using System.Text;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        const string baseUrl = "https://host.example.com/restApi";
        const string endpoint = "/api/directoryObjects/groupMembers";
        const string token = "HxtdAPz73OFfae7....w7lQvxjJHIbVqgkCtPtLD";

        // Create JSON request body
        string jsonRequest = @"
        {
            'group': 'CN=My Group,OU=Groups,DC=example,DC=com',
            'newMember': 'CN=John Smith,CN=Users,DC=example,DC=com'
        }";
        StringContent requestBody = new StringContent(
            jsonRequest, Encoding.UTF8, "application/json");

        // Initialize HTTP client
        using (HttpClient client = new HttpClient())
        {
            client.DefaultRequestHeaders.Add("Adm-Authorization", token);

            // Make request
            HttpResponseMessage response = await client.PostAsync(
                baseUrl + endpoint, requestBody);
            string responseBody = response.Content.ReadAsStringAsync().Result;
            Console.WriteLine(responseBody);
        }
    }
}
cURL
curl  --header 'Adm-Authorization: HxtdAPz73OFfae7....w7lQvxjJHIbVqgkCtPtLD' \
--header 'Content-Type: application/json' \
--request POST 'https://host.example.com/restApi/api/directoryObjects/groupMembers' \
--data-raw '{
    "group": "CN=My Group,OU=Groups,DC=example,DC=com",
    "newMember": "CN=John Smith,CN=Users,DC=example,DC=com"
}'
node.js
var https = require('https');

// Request parameters and headers
var options = {
    'method': 'POST',
    'hostname': 'host.example.com',
    'path': '/restapi/api/directoryObjects/groupMembers',
    'headers': {
        'Adm-Authorization': 'HxtdAPz73OFfae7....w7lQvxjJHIbVqgkCtPtLD',
        'Content-Type': 'application/json'
    }
};

// Create JSON request body
var postData = `
{
    "group": "CN=My Group,OU=Groups,DC=example,DC=com",
    "newMember": "CN=John Smith,CN=Users,DC=example,DC=com"
}`;

// Make request
var req = https.request(options, function (res) {
    var chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        var body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

req.write(postData);

req.end();

Response

HTTP Status code: 200 OK
Response body:

{
    "resultType": 0,
    "innerMessages": [],
    "exception": null,
    "actualObjectDN": "CN=My Group,OU=Groups,DC=example,DC=com",
    "extraInfo": {}
}

See also