Add Member To Groups
Configuration reference for the Add Member To Groups Pipes valve and its supported options.
Introduction
Section titled “Introduction”Before using this valve the LdapClient module must be configured and deployed with matching name as defined in "namespace"
Configuration
Section titled “Configuration”| Name | Description | Default | Mandatory | Expanded |
|---|---|---|---|---|
namespace | Bind to LdapClient module. | "default" | ||
member_id | User/Member id. | |||
groups_identifier | JsonArray with group objects or group DNs. | "@json:${request.ad_pending_add.all}" | ||
id_property | Property on JSON object that contains the group DN. | "id" |
{ "name": "ActiveDirectoryAddMemberToGroups", "config": { "namespace": "ldap01", "member_id": "${request.selected_ad_id}", "id_property": "id", "groups_identifier": "@json:${request.ad_pending_add.all}" }}Example pipe data
Section titled “Example pipe data”{"selected_ad_id" : "CN=Britt Thomasson,OU=Demo,DC=company,DC=local", "ad_pending_add": [ { "id": "CN=AWS administrator,OU=access_review,OU=Governance,OU=IdM_demo,OU=Product_Testing,DC=company,DC=local", "description": "Test", "cn": "AWS administrator", "sAMAccountName": "AWS administrator" }, { "id": "CN=Cert Publishers,CN=Users,DC=company,DC=local", "description": "Members of this group are permitted to publish certificates to the directory", "cn": "Cert Publishers", "sAMAccountName": "Cert Publishers" }]}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_typegroup,package_typeGroupMembershipAdded- one change published per group in
groups_identifier, each with its ownobject_id— that group's DN — and a single change,fieldmember,after_valuethe member's DN (member_id)
[ { "object_id": "CN=AWS administrator,OU=access_review,OU=Governance,OU=IdM_demo,OU=Product_Testing,DC=company,DC=local", "field": "member", "after_value": "CN=Britt Thomasson,OU=Demo,DC=company,DC=local" }, { "object_id": "CN=Cert Publishers,CN=Users,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.