Remove Group From Members

Introduction

Before using this valve the LdapClient module must be configured and deployed with matching name as defined in "namespace"

Configuration

Note

Valve name: ActiveDirectoryRemoveGroupFromMembers

Properties

Name	Description	Default	Mandatory	Expanded
namespace	Bind to LdapClient module.	"default"
group_id	Group DN.
members_identifier	JsonArray with member objects or member DN.	"@json:${request.ad_pending_remove.all}"
id_property	Property on JSON object that contains the member DN.	"id"

Example

Read data from the pipe request:

{
  "name": "ActiveDirectoryRemoveGroupFromMembers",
  "config": {
    "namespace": "ldap01",
    "id_property": "id",
    "group_id": "${request.selected_ad_id}",
    "members_identifier": "@json:${request.ad_pending_remove.all}"
  }
}

Read data from the current item:

{
  "name": "ActiveDirectoryRemoveGroupFromMembers",
  "config": {
    "namespace": "ldap01",
    "id_property": "id",
    "group_id": "${item.group_dn}",
    "members_identifier": "@json:${item.members.all}"
  }
}

Example pipe data (from pipe request)

{
  "selected_ad_id": "CN=Cert Publishers,CN=Users,DC=company,DC=local",
  "ad_pending_remove" : [
    {
        "id" : "CN=Lance Armsson,OU=Demo,DC=company,DC=local",
        "displayName" : "Lance Armsson"
    },
    {
        "id" : "CN=Britt Thomasson,OU=Demo,DC=company,DC=local",
        "displayName" : "Britt Thomasson"
    }
  ]
}

Audit

Every successful call publishes changes to the platform audit trail automatically — there is no audit flag to configure. Whether anything is actually recorded depends on whether an Audit module is deployed to consume it.

• object_type group, package_type GroupMembershipRemoved
• object_id — the group's DN (group_id)
• one change per member removed, field member, after_value the member's DN

[
  { "field": "member", "after_value": "CN=Lance Armsson,OU=Demo,DC=company,DC=local" },
  { "field": "member", "after_value": "CN=Britt Thomasson,OU=Demo,DC=company,DC=local" }
]

See Audit for how published changes are grouped into events and change packages, and for the built-in UI and REST API to view them.