スクリプト開発向けim-BizAPI

PasswordHistoryManagerオブジェクト

コンポーネント情報
version8.0.13
since6.0
コンポーネント概要
パスワード履歴管理情報オブジェクト。

パスワード履歴管理情報の参照、更新を行うマネージャオブジェクトです。

バージョンによる挙動の変更について
version 8.0.13 以降、以下のメソッドの挙動に変更があります。詳細は各メソッドの説明を参照してください。
  • getPasswordHistories(String)
  • getLatestPasswordHistory(String)

コンストラクタの概要

PasswordHistoryManager ()
コンストラクタ。
PasswordHistoryManager (String groupId) 非推奨
コンストラクタ。

メソッドの概要

返却値の型 メソッド名
Boolean addPasswordHistory (String userCd, String password)
パスワード履歴を追加します。
PasswordHistoryResultInfo checkPasswordHistory (String userCd, String password)
パスワードの入力チェックを行います。
PasswordHistoryResultInfo checkPassword (String userCd, String password)
パスワードの入力チェック。
Boolean clearPasswordHistories ()
パスワード履歴をすべて消去します。
Boolean clearPasswordHistory (String userCd)
引数のユーザのパスワード履歴を消去します。
String createPassword (String count)
パスワードをランダムに生成します。
PasswordHistoryInfo getLatestPasswordHistory (String userCd)
最新のパスワードと更新日付を取得します。
Number getPasswordExpireLimit ()
設定したパスワードの有効期限を取得します。
Array getPasswordHistories (String userCd)
パスワード履歴を取得します。
Number getPasswordHistoryCount (String userCd)
パスワード履歴数を取得します。
Number getPasswordHistoryManagedCount ()
世代管理数を取得します。
String getPasswordPage ()
パスワード変更画面のURLを取得します。
Boolean isChangePasswordFirstLogin ()
初回ログイン時にパスワード変更要求を行うか判定します。
Boolean isDenyClientType (String clientType)
クライアントタイプを判定します。
Boolean isFirstLogin (String userCd)
初回ログインを判定します。
Boolean isForwardInitialPage ()
パスワード変更後の画面遷移を判定します。
Boolean isPasswordExpired (String userCd, String clientType, Date date)
パスワード有効期限切れかどうか判定します。
Boolean isPasswordHistoryManaged ()
履歴管理を行うかどうか判定します。
Boolean setFirstLogin (String userCd, Boolean isFirstLogin)
初回ログインの設定を行います。
Boolean verifyPasswordHistory (String userCd, Number remain)
ユーザのパスワードを消去します。

コンストラクタの詳細

PasswordHistoryManager ()
コンストラクタ。
PasswordHistoryManager (String groupId) 非推奨
コンストラクタ。
パラメータ
groupId : String
ログイングループID

メソッドの詳細

Boolean addPasswordHistory (String userCd, String password)
パスワード履歴を追加します。

指定ユーザの入力パスワードをデータベースに追加します。
パラメータ
userCd : String
ユーザコード
password : String
パスワード
返却値
Boolean
Boolean true：履歴の追加に成功 / false：履歴の追加に失敗
PasswordHistoryResultInfo checkPasswordHistory (String userCd, String password)
パスワードの入力チェックを行います。
パラメータ
userCd : String
ユーザコード
password : String
パスワード
返却値
PasswordHistoryResultInfo
PasswordHistoryResultInfo パスワード履歴チェック結果オブジェクト
PasswordHistoryResultInfo checkPassword (String userCd, String password)
パスワードの入力チェック。

この関数では、パスワードの利用可能文字のみチェックを行います。
パスワードの世代管理チェックは行いません。
旧パスワードの使用禁止についてもチェックを行いたい場合は、String) を利用してください。
パラメータ
userCd : String
ユーザコード
password : String
パスワード
返却値
PasswordHistoryResultInfo
PasswordHistoryResultInfo パスワード履歴チェック結果オブジェクト
Boolean clearPasswordHistories ()
パスワード履歴をすべて消去します。
返却値
Boolean
Boolean true：履歴の消去に成功 / false：履歴の消去に失敗
Boolean clearPasswordHistory (String userCd)
引数のユーザのパスワード履歴を消去します。
パラメータ
userCd : String
ユーザコード
返却値
Boolean
Boolean true：履歴の消去に成功 / false：履歴の消去に失敗
String createPassword (String count)
パスワードをランダムに生成します。

引数の値の長さのパスワードをランダムに生成します。
呼出し毎に異なるパスワードを生成します。
パラメータ
count : String
パスワードの長さ
返却値
String
String 生成されたパスワード
PasswordHistoryInfo getLatestPasswordHistory (String userCd)
最新のパスワードと更新日付を取得します。

指定ユーザの最新パスワードと更新日付を取得します。
パスワード保存方式に「ハッシュ化」を利用している場合、パスワード履歴情報オブジェクトに設定されるパスワード値はnullとなります。
パラメータ
userCd : String
ユーザコード
返却値
PasswordHistoryInfo
PasswordHistoryInfo パスワード履歴情報オブジェクト
エラー発生時はnullを返します。
Number getPasswordExpireLimit ()
設定したパスワードの有効期限を取得します。

パラメータで設定したパスワードの有効期限日数を取得します。
返却値
Number
Number パスワード有効期限日数
Array getPasswordHistories (String userCd)
パスワード履歴を取得します。

指定ユーザのパスワード履歴を取得します。
パスワード保存方式に「ハッシュ化」を利用している場合、パスワード履歴情報オブジェクトに設定されるパスワード値はnullとなります。
パラメータ
userCd : String
ユーザコード
返却値
Array
Array 指定ユーザの パスワード履歴情報オブジェクト の一覧
エラー発生時はnullを返します。
Number getPasswordHistoryCount (String userCd)
パスワード履歴数を取得します。

指定ユーザのパスワード履歴数を取得します。
取得に失敗した場合は-1が返却されます。
パラメータ
userCd : String
ユーザコード
返却値
Number
Number パスワード履歴数
Number getPasswordHistoryManagedCount ()
世代管理数を取得します。

パスワードの世代管理数を取得します。
取得に失敗した場合は-1が返却されます。
返却値
Number
Number パスワード世代管理数
String getPasswordPage ()
パスワード変更画面のURLを取得します。

パスワード変更画面のURLを取得します。
返却値
String
String パスワード変更画面のURL
Boolean isChangePasswordFirstLogin ()
初回ログイン時にパスワード変更要求を行うか判定します。
返却値
Boolean
Boolean true：パスワード変更要求を行う / false：パスワード変更要求を行わない
Boolean isDenyClientType (String clientType)
クライアントタイプを判定します。

パラメータdeny-client-typesに記述があるクライアントタイプの判定を行います。
パラメータ
clientType : String
クライアントタイプ
返却値
Boolean
Boolean true：クライアントタイプが含まれている / false：クライアントタイプが含まれていない
Boolean isFirstLogin (String userCd)
初回ログインを判定します。
パラメータ
userCd : String
ユーザコード
返却値
Boolean
Boolean true：初回ログイン / false：初回ログインではない
Boolean isForwardInitialPage ()
パスワード変更後の画面遷移を判定します。

パスワードの有効期限切れによるパスワード再設定後、ログイン画面に戻るか、ログイン処理を継続してログインするかを判定します。
返却値
Boolean
Boolean true：ログイン画面に戻る / false：ログイン処理を継続してログインする
Boolean isPasswordExpired (String userCd, String clientType, Date date)
パスワード有効期限切れかどうか判定します。
パラメータ
userCd : String
ユーザコード
clientType : String
クライアントタイプ
date : Date
パスワードのチェックの基準となる日付。省略された場合、現在日付が利用されます。
返却値
Boolean
Boolean true : パスワード有効期限切れ / false : パスワード有効期限内
Boolean isPasswordHistoryManaged ()
履歴管理を行うかどうか判定します。
返却値
Boolean
Boolean ture：履歴管理を行う / false：履歴管理を行わない
Boolean setFirstLogin (String userCd, Boolean isFirstLogin)
初回ログインの設定を行います。

指定ユーザを初回ログインとする設定を行います。
パラメータ
userCd : String
ユーザコード
isFirstLogin : Boolean
初回ログインとするかどうか？
返却値
Boolean
Boolean true：処理が成功 / false：処理が失敗
Boolean verifyPasswordHistory (String userCd, Number remain)
ユーザのパスワードを消去します。

引数remainの値分残してユーザの履歴を消去します。
引数remainが0以下の場合、履歴をすべて消去します。
パラメータ
userCd : String
ユーザコード
remain : Number
残す履歴の数
返却値
Boolean
Boolean true：履歴の消去に成功 / false：履歴の消去に失敗

Copyright © 2012 NTT DATA INTRAMART CORPORATION