Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

DIR.ADDGROUPMEMBER

Adds a member to a group.

Syntax

<DIR.ADDGROUPMEMBER 
      NAME="group" 
      MEMBER="member entry"/>

Parameters

NAME (required)

Unique identifier for the name of the entry to which members are being added. The value is relative to the baseDN property.

MEMBER (required)

Name of the entry to add as a member (usually, but not required to be, a user). The value is relative to the baseDN property, but is changed to the fully qualified distinguished name prior to adding as a value to the CS.Property.dir.uniquemember attribute.

errno

The possible values of errno include:

Value	Description
-15004	Implementation doesn't support this operation
-15005	Unexpected naming exceptions from JNDI provider.
-15006	A required property missing, or class name specified for factory classes is in error.
-15007	Unexpected schema violation errors from JNDI provider.
-15008	General error in the syntax of an IName.
-15009	Unexpected invalid attribute exceptions from JNDI provider
-15010	Unexpected invalid attribute id exceptions from JNDI provider.
-15011	Unexpected invalid attribute value exceptions from JNDI provider.
-15012	User does not have permission to perform the operation.
-15013	Node cannot be deleted because it has children.
-15014	Unexpected JNDI read error.
-15015	Unexpected JNDI write error.
-15016	JNDI attribute already in use.
-15017	User is already a member.
-15020	User is not valid.
-15023	Unexpected JNDI connection errors.
-15024	Required attribute missing.
-15025	Unknown error.
-15026	Missing required create attribute.
-15027	User create SQL failure.
-15028	User delete SQL failure.
-15029	Cannot delete user attributes.
-15030	SQL error.
-15031	Query failed.
-15032	Add attribute SQL failed.
-15035	Database error occurred while attempting to assign the user to a group.
-15036	Missing or invalid child argument tags for tag.

Description

Adds a member to a group. Note that this tag does not add a child to a group. The API implementation, not the client code, is responsible for checking that the member is a valid, existing distinguished name. If the specified entry is already a member, nothing is done.

In most SPIs, this entails adding the specified user's distinguished name to the set of values of the specified group's uniquemember attribute.

If the CS.Property.dir.referentialIntegrity property is turned on, the CS.Property.dir.member attribute (backlink) of the user is also updated, if implemented by the SPI (e.g., the value in the property file is non-empty).

Example

<DIR.ADDGROUPMEMBER NAME="Variables.groupName"  
                    MEMBER="Variables.userName"/>

Release Introduced

This tag was introduced in Content Server release 4.0.

		Home >	Contents >	Index >
	FatWire XML Tag Reference Copyright 2005 by FatWire Software All rights reserved.