resetPassword()
構文
使用方法
resetPassword() は、API で User または SelfServiceUser のパスワード変更し、ランダムな文字と数字から成るシステムが生成したパスワードを取得する場合に使用します。特定の値にパスワードを設定する場合は、setPassword() を使用します。
クライアントアプリケーションは、そのユーザのパスワードを変更するために必要なアクセス権限でログインされている必要があります。詳細は、「データアクセスに影響する要素」を参照してください。
ID についての詳細は、「ID データ型」を参照してください。
サンプルコード —Java
このサンプルでは、userId パラメータで指定されたユーザのパスワードをリセットします。この ID を使用して resetPassword() をコールし、コールの結果から仮のパスワードを取得します。この仮のパスワードをコンソールに書き込み、そのパスワードを返します。
サンプルコード —C#
このサンプルでは、userId パラメータで指定されたユーザのパスワードをリセットします。この ID を使用して resetPassword() をコールし、コールの結果から仮のパスワードを取得します。この仮のパスワードをコンソールに書き込み、そのパスワードを返します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| userID | ID | パスワードをリセットする User または SelfServiceUser の ID。ID についての詳細は、「ID データ型」を参照してください。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| password | string | API によって生成された新しいパスワード。このパスワードでユーザがログインすると、そのユーザは新しいパスワードを提供するように求められます。このパスワードは一時的なもので、ユーザが新しいパスワードを設定したら再利用することができないパスワードです。 |