pp108 : Update

Update


This Web service operation is used to update the LDAP (to add new entries, to update existing entries, or to delete entries).

SOAP Request

Depending upon the type of the LDAP entry, the request parameters will vary.

Updating an LDAP Entry
The SOAP message uses the Update Web service operation, containing both old and new values of the LDAP entry. 

<Update xmlns="http://schemas.cordys.com/1.0/ldap">
    <tuple>
        <old>
            <entry dn="cn=rwhite, cn=organizational users, o=vanenburg.com, cn=cordys, o=vanenburg.com">
                <cn>
                    <string>rwhite</string>
                </cn>
                <objectclass>
                    <string>top</string>
                    <string>busorganizationaluser</string>
                </objectclass>
                <authenticationuser>
                    <string>cn=rwhite, cn=authenticated users, cn=cordys, o=vanenburg.com</string>
                </authenticationuser>
                <menu>
                    <string>busadministrator.menu</string>
                </menu>
                <description>
                    <string>R White</string>
                </description>
            </entry>
        </old>
        <new>
            <entry dn="cn=rwhiteray, cn=organizational users, o=vanenburg.com, cn=cordys, o=vanenburg.com">
                <cn>
                    <string>rwhiteray</string>
                </cn>
                <objectclass>
                    <string>top</string>
                    <string>busorganizationaluser</string>
                </objectclass>
                <authenticationuser>
                    <string>cn=rwhite, cn=authenticated users, cn=cordys, o=vanenburg.com</string>
                </authenticationuser>
                <menu>
                    <string>busadministrator.menu</string>
                </menu>
                <description>
                    <string>R White</string>
                </description>
            </entry>
        </new>
    </tuple>
</Update>

Deleting an LDAP entry
The SOAP message uses the Update Web service operation, containing the values of the old entry. 

<Update xmlns="http://schemas.cordys.com/1.0/ldap">
    <tuple>
        <old>
            <entry dn="cn=rwhite, cn=organizational users, o=vanenburg.com, cn=cordys, o=vanenburg.com">
                <cn>
                    <string>rwhite</string>
                </cn>
                <objectclass>
                    <string>top</string>
                    <string>busorganizationaluser</string>
                </objectclass>
                <authenticationuser>
                    <string>cn=rwhite, cn=authenticated users, cn=cordys, o=vanenburg.com</string>
                </authenticationuser>
                <menu>
                    <string>busadministrator.menu</string>
                </menu>
                <description>
                    <string>R White</string>
                </description>
            </entry>
        </old>
    </tuple>
</Update>

Inserting an LDAP Entry
The SOAP message uses the Update Web service operation, containing the values of the new entry. 

<Update xmlns="http://schemas.cordys.com/1.0/ldap">
    <tuple>
        <new>
            <entry dn="cn=rwhite, cn=organizational users, o=vanenburg.com, cn=cordys, o=vanenburg.com">
                <cn>
                    <string>rwhite</string>
                </cn>
                <objectclass>
                    <string>top</string>
                    <string>busorganizationaluser</string>
                </objectclass>
                <authenticationuser>
                    <string>cn=rwhite, cn=authenticated users, cn=cordys, o=vanenburg.com</string>
                </authenticationuser>
                <menu>
                    <string>busadministrator.menu</string>
                </menu>
                <description>
                    <string>R White</string>
                </description>
            </entry>
        </new>
    </tuple>
</Update>

Request Parameters

Parameter

Description

tuple

Contains a tuple.

old

Contains the old entry that has to be modified.

new

Contains the new entry that has to replace the old entry.


SOAP Response

The SOAP response comprises the updated LDAP content. Below is the sample SOAP response for
Inserting an LDAP Entry. 

<Updateresponse xmlns="http://schemas.cordys.com/1.0/ldap">
    <tuple>
        <new>
            <entry dn="cn=rwhite, cn=organizational users, o=vanenburg.com, cn=cordys, o=vanenburg.com">
                <cn>
                    <string>rwhite</string>
                </cn>
                <objectclass>
                    <string>top</string>
                    <string>busorganizationaluser</string>
                </objectclass>
                <authenticationuser>
                    <string>cn=rwhite, cn=authenticated users, cn=cordys, o=vanenburg.com</string>
                </authenticationuser>
                <menu>
                    <string>busadministrator.menu</string>
                </menu>
                <description>
                    <string>R White</string>
                </description>
            </entry>
        </new>
    </tuple>
</Updateresponse>