# modify-password

<modify-password> is used:

- As an event notification from the PublicationShim to DirXML that on object password was modified in the application. When used as a notification, an <association> is required.
- As a command from DirXML to the SubsciptionShim to modify an object password in the application. When used as a command, an <association> is required and is the unique key of the object to modify.

When the target is eDirectory, and <old-password> is specified, the modifyPassword API is used to modify the password. If not specified, the GenerateKeyPair API is used. Note that using GenerateKeyPair may invalidate authentication credentials for any existing session authenticated as the target object.

When the target is the application, a driver may or may not implement this functionality, depending on the applicability to the application.

A response to <modify-password> should be a <status> indicating whether or not the <modify-password> was processed successfully.

Example

>     <modify-password class-name="User" src-dn="\Sam">
>      <association>1012</association>
>      <password>mypassword<password>
>     </modify-password>

## 1. Allowed Content

> association
>   Unique key of the application object.
> old-password
>   The old authentication password.
> password
>   The authentication password.
> operation-data
>   Operation additional custom data.

## 2. Attributes

> Attribute | Value(s) | Default Value
> --- | --- | ---
> class-name | CDATA The name of the base class of the object. The class name is mapped between the application and eDirectory name spaces by the schema mapping rule so that DirXML will see the name in the eDirectory namespace and a driver will see the name in the application name space. Required when used as a notification | #IMPLIED
> dest-dn | CDATA The distinguished name of the target object in the namespace of the receiver. | #IMPLIED
> dest-entry-id | CDATA The entry id of the target object in the namespace of the receiver. (Reserved) Should be ignored by the driver. | #IMPLIED
> event-id | CDATA An identifier used to tag the results of an event or command. | #IMPLIED
> from-merge | true | false "true" if command is the result of a merge. | false
> qualified-src-dn | CDATA The qualified version of src-dn. Only used for describing objects from eDirectory. | #IMPLIED
> src-dn | CDATA The distinguished name of source object that generated the event in the namespace of the sender. | #IMPLIED
> src-entry-id | CDATA The entry id of source object that generated the event in the namespace of the sender. (Reserved) Should be ignored by the driver. | #IMPLIED
> timestamp | CDATA (Reserved) Should be ignored by the driver. | #IMPLIED

## 3. Content Rule

> ( association ? , old-password ? , password , operation-data ? )

## 4. Parent Elements

> input
>   Input events or commands.

Top Elements || All Elements || Tree