setPassword()

構文

1SetPasswordResult setPasswordResult = connection.setPassword(ID userID, string password);

使用方法

User または SelfServiceUser のパスワードを指定の値に変更するには、setPassword() を使用します。たとえば、クライアントアプリケーションは、ユーザに異なるパスワードを指定するように促し、次にシステム管理者によるユーザのパスワード変更のためにsetPassword() を呼び出す可能性があります。API によって生成されたランダム値にパスワードをリセットする場合は、代わりに、resetPassword() を使用してください。

このコールは、組織のパスワードポリシー設定 [セルフリセットに setPassword() API を使用することを許可] が有効である場合に限り、ユーザに自分のパスワード変更を許可するために使用できます。それ以外の場合は、changeOwnPassword() を使用します。変更を許可する前にユーザーの現在のパスワードを確認するため、こちらの方が安全です。

クライアントアプリケーションは、そのユーザのパスワードを変更するために必要なアクセス権限でログインされている必要があります。詳細は、「データアクセスに影響する要素」を参照してください。

ID についての詳細は、「ID データ型」を参照してください。

パスワードが失効していた場合、このコールは、LoginResult 内で返されるセッション ID を使用可能です。詳細は、「passwordExpired」 を参照してください。

サンプルコード —Java

このサンプルでは、ユーザ ID およびパスワードパラメータを受け取り、これらを使用して指定されたユーザのパスワードを設定する setPassword() コールを実行します。

1public void doSetPassword(String userId, String newPasswd) {
2   try {
3      SetPasswordResult result = connection.setPassword(userId, newPasswd);
4      System.out.println("The password for user ID " + userId + " changed to "
5            + newPasswd);
6   } catch (ConnectionException ce) {
7      ce.printStackTrace();
8   }
9}

サンプルコード —C#

このサンプルでは、ユーザ ID およびパスワードパラメータを受け取り、これらを使用して指定されたユーザのパスワードを設定する setPassword() コールを実行します。

1public void doSetPassword(String userId, String newPasswd)
2{
3   try
4   {
5      SetPasswordResult result = binding.setPassword(userId, newPasswd);
6      Console.WriteLine("The password for user ID " + userId + " changed to "
7            + newPasswd);
8   }
9   catch (SoapException e)
10   {
11      Console.WriteLine("An unexpected error has occurred: " +
12                        e.Message + "\n" + e.StackTrace);
13   }
14}

引数

応答

SetPasswordResult (空)

障害

InvalidIdFault

UnexpectedErrorFault