Active Directory Provider::User Set Password

Sets a user's initial password. Used by Microsoft® Provisioning Framework (MPF).

User Set Password is a wrapper for IADsUser::SetPassword.

XML Input Schema

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

<executeData>1..1
  <path>1..1</path>
  <newPassword>1..1</newPassword>
  <flagSkipAction>0..1</flagSkipAction>
</executeData>

XML Output Schema

User Set Password does not return data.

Elements and Attributes

The following table describes the XML schema elements and attributes. Unless otherwise indicated, the data type is string.

Element Description, relationships, and attributes
executeData Description:
 Encapsulates the procedure's input data.

Children:
 flagSkipAction (minOccurs="0" maxOccurs="1")
newPassword (minOccurs="1" maxOccurs="1")
path (minOccurs="1" maxOccurs="1")
flagSkipAction Description:
Prevents the procedure from executing. If this element is specified, the procedure does not update the user's password, even during rollback.

Now that MPF supports try/catch error handling (through try and catch elements), there is little need to specify flagSkipAction. This node was originally introduced to support error handling for Create Object. For example, a Create Object call ordinarily fails if the user already exists. To override this behavior, the request can include a flagIgnoreAlreadyExistsError node, which instructs Create Object to return a flagSkipAction node. Subsequent calls pass this node to prevent further operations on the object. In the case of User Set Password, the presence of flagSkipAction prevents accidental resets of the user's password.

Parent:
executeData

newPassword Description:
New password.

Parent:
executeData

path Description:
Lightweight directory access protocol (LDAP) path of the object to set the password of.

Parent:
executeData

See Also

Active Directory Provider, Preferred DC Active Directory Provider

Up Top of Page
© 1999-2002 Microsoft Corporation. All rights reserved.