Remove group member
Removes a member from the specified group.
DELETE ~/api/directoryObjects/groupMembers?<parameters>
Query parameters
-
Name
-
Required
-
Type
-
Description
-
group
-
True
-
string
-
The identifier of the group to remove a member from. 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
-
member
-
True
-
string
-
The identifier of the member which should be removed. A group member 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
Request headers
-
Name
-
Required
-
Description
-
Adm-Authorization
-
True
-
Specify the security token obtained during authentication.
Request body
Do not send a body with this request.
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
Remove a group member
The following code sample removes a user from the specified group.
Request
- PowerShell
-
Add-Type -AssemblyName System.Web $memberIdentifier = [System.Web.HttpUtility]::UrlEncode("CN=John Smith,CN=Users,DC=example,DC=com") $groupIdentifier = [System.Web.HttpUtility]::UrlEncode("CN=My Group,OU=Groups,DC=example,DC=com") $baseUrl = "https://host.example.com/restApi" $endpoint = "/api/directoryObjects/groupMembers" $requestParams = "?group=$groupIdentifier&member=$memberIdentifier" $requestUrl = $baseUrl + $endpoint + $requestParams $requestHeaders = @{"Adm-Authorization"="HxtdAPz73OFfae7....w7lQvxjJHIbVqgkCtPtLD"} # Make request Invoke-RestMethod -Method DELETE -Headers $requestHeaders -Uri $requestUrl
- C#
-
using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main() { const string groupIdentifier = "CN=My Group,OU=Groups,DC=example,DC=com"; const string memberIdentifier = "CN=John Smith,CN=Users,DC=example,DC=com"; const string token = "HxtdAPz73OFfae7....w7lQvxjJHIbVqgkCtPtLD"; UriBuilder requestUrl = new UriBuilder( "https://host.example.com/restApi/api/directoryObjects/groupMembers"); requestUrl.Query += $"?group={groupIdentifier}"; requestUrl.Query += $"&member={memberIdentifier}"; // Initialize HTTP client using (HttpClient client = new HttpClient()) { client.DefaultRequestHeaders.Add("Adm-Authorization", token); // Make request HttpResponseMessage response = await client.DeleteAsync(requestUrl.ToString()); string responseBody = response.Content.ReadAsStringAsync().Result; Console.WriteLine(responseBody); } } }
- cURL
-
curl --header 'Adm-Authorization: HxtdAPz73OFfae7....w7lQvxjJHIbVqgkCtPtLD' \ --get -X DELETE 'https://host.example.com/restApi/api/directoryObjects/groupMembers' \ --data-urlencode 'group=CN=My Group,OU=Groups,DC=example,DC=com' \ --data-urlencode 'member=CN=John Smith,CN=Users,DC=example,DC=com'
- node.js
-
var groupIdentifier = encodeURIComponent("CN=My Group,OU=Groups,DC=example,DC=com"); var memberIdentifier = encodeURIComponent("CN=John Smith,CN=Users,DC=example,DC=com"); var https = require('https'); // Request parameters and headers var requestPath = "/restApi/api/directoryObjects/groupMembers" + `?group=${groupIdentifier}` + `&member=${memberIdentifier}`; var options = { 'method': 'DELETE', 'hostname': 'host.example.com', 'path': requestPath, 'headers': { 'Adm-Authorization': 'HxtdAPz73OFfae7....w7lQvxjJHIbVqgkCtPtLD' } }; // 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.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": {}
}