SetPassword Method of the MIIS_CSObject Class

The SetPassword method sets the password on a connector space object to a new password. This method requires that password synchronization be enabled for the management agent. To use this method, you must be logged on as a member of the MIISPasswordSet security group.

Syntax

string SetPassword(
  [in]  string NewPassword,
  [in]  bool ForceChangeAtLogon,
  [in]  bool UnlockAccount
);

Parameters

• NewPassword [in]
  Contains the new password.

• ForceChangeAtLogon [in]
  True to force a user password change at the next logon. The default is False.

  Note  This flag works only with the Management agent for Active Directory and the Management agent for Active Directory global address list (GAL). For other management agents, the operation-not-supported exception will be thrown.

• UnlockAccount [in]
  True to unlock an account in the CD. The default is False.

  Note  This flag works only with the Management agent for Active Directory and the Management agent for Active Directory global address list (GAL). For other management agents, the operation-not-supported exception will be thrown.

Return Value

Returns a string that contains the results of the method. The return value can be one of the following values.

Remarks

This method works only with the following management agents:

• Management agent for Active Directory
• Management agent for Active Directory Application Mode (ADAM)
• Management agent for Active Directory global address list (GAL)
• Management agent for Lotus Notes Release 4.6 or 5.0
• Management agent for Novell eDirectory 8.62 or 8.7
• Management agent for Windows NT 4.0
• Management agent for Sun ONE Directory Server 4.1x and 5.x (formerly iPlanet Directory Server) and Netscape Directory Server 4.1 and 6.01

For the management agent for Active Directory and the management agent for Active Directory global address list (GAL), the preferred domain controller is used to locate the server with the partition that contains the connector space object.

When you call the SetPassword method, an entry is written to the event log. The entry contains information about who made the request, the target of the request, and the status of the request.

Examples

The following example shows how to use Visual Basic Scripting Edition (VBScript) to set the password of the account Jeff in the main domain to NewPassword.

Option Explicit

on Error Resume Next

Dim Service
Dim CsObjects
Dim CsObject

Set  Service = GetObject("winmgmts:root\MicrosoftIdentityIntegrationServer")
Set CsObjects = Service.ExecQuery("Select * from MIIS_CSObject where domain='main' and account='Jeff'")

For Each CsObject in CsObjects
   WScript.Echo "SetPassword returns " & CsObject.SetPassword("NewPassword")
Next

Sub ErrorHandler (ErrorMessage)
  WScript.Echo ErrorMessage
  WScript.Quit(1)
End Sub

The following example shows how to use Visual Basic Scripting Edition (VBScript) to set the password of the account Jeff in the main domain to NewPassword. It also forces the user to change the password at the next logon.

Option Explicit

on Error Resume Next

Dim Service
Dim CsObjects
Dim CsObject
Dim ForcePasswordChange
Dim UnlockAccount

Set  Service = GetObject("winmgmts:root\MicrosoftIdentityIntegrationServer")
Set CsObjects = Service.ExecQuery("Select * from MIIS_CSObject where domain='main' and account='Jeff'")

ForcePasswordChange = true  'this forces the user to change the password at next logon.
UnlockAccount = true        'this unlocks the account in cases the account was locked out.

For Each CsObject in CsObjects
   WScript.Echo "SetPassword returns " & CsObject.SetPassword("NewPassword", ForcePasswordChange, UnlockAccount)
Next

Sub ErrorHandler (ErrorMessage)
  WScript.Echo ErrorMessage
  WScript.Quit(1)
End Sub

Requirements

Send comments about this topic to Microsoft

Build date: 2/16/2009