CLI ユーザ メソッド

目次
casso1283
目次
DisableByAdmin メソッド - Disabled-by-Administrator フラグを設定または取得
DisableByAdmin メソッドは、ユーザ アカウントが管理者によって無効化されるかどうかを指定する disabled-by-administrator フラグを設定または取得します。
構文
DisableByAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->DisableByAdmin([disableFlag])
[Parameters]
DisableByAdmin メソッドは以下のパラメータを受け入れます。
  1. disableFlag
    (int)
    (オプション)disabled-by-administrator フラグの新しい値を指定します。
    • 値 = 1
      ユーザ アカウントが管理者によって無効化されることを指定します。
    • 値 = 0
      ユーザ アカウントが管理者によって無効化されないことを指定します。
      : ユーザ アカウントは他の理由で無効になる場合があります。詳細については、「注釈」を参照してください。
戻り値
DisableByAdmin メソッドは、以下のように disabled-by-administrator フラグの新規または既存の値を返します。
  • 値 = 1
    ユーザ アカウントが管理者によって無効化されることを指定します。
  • 値 = 0
    ユーザ アカウントが管理者によって無効化され
    ない
    ことを指定します。
    : ユーザ アカウントは他の理由で無効になる場合があります。詳細については、「注釈」を参照してください。
  • 値 = -1
    コールが失敗したことを指定します。
注釈
ユーザ アカウントは以下の 1 つ以上の理由で無効になる場合があります。
  • 管理者がユーザ アカウントを無効にした。
  • アカウント非アクティブ状態が許可されている時間を超えました。
    詳細については、メソッド PolicyMgtUser>DisableInactive を参照してください。
  • ログイン失敗の数が許可されている最大数を超えた。
    詳細については、メソッド PolicyMgtUser>DisableMaxLoginFail を参照してください。
  • パスワードが期限切れになった。
    詳細については、メソッド PolicyMgtUser>DisablePwdExpired を参照してください。
DisableInactive メソッド - Disabled-by-Inactivity フラグを設定または取得
DisableInactive メソッドは、アカウントの非アクティブ状態が許可された時間を超えたことを理由にユーザ アカウントが無効化されるかどうかを指定する、disabled-by-inactivity フラグを設定または取得します。
構文
DisableInactive メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->DisableInactive([disableFlag])
[Parameters]
DisableInactive メソッドは以下のパラメータを受け入れます。
  1. disableFlag
    (int)
    (オプション)disabled-by-inactivity フラグの新しい値を指定します。
    • 値 = 1
    ユーザ アカウントが非アクティブ状態のために無効化されることを指定します。
    • 値 = 0
    ユーザ アカウントが非アクティブ状態のために無効化されないことを指定します。
    : ユーザ アカウントは他の理由で無効になる場合があります。詳細については、「注釈」を参照してください。
戻り値
DisableInactive メソッドは、以下のように disabled-by-inactivity フラグの新規または既存の値を返します。
  • 値 = 1
    ユーザ アカウントが非アクティブ状態のために無効化されることを指定します。
  • 値 = 0
    ユーザ アカウントが非アクティブ状態のために無効化され
    ない
    ことを指定します。
    : ユーザ アカウントは他の理由で無効になる場合があります。詳細については、「注釈」を参照してください。
  • 値 = -1
    コールが失敗したことを指定します。
注釈
ユーザ アカウントは以下の 1 つ以上の理由で無効になる場合があります。
  • 管理者がユーザ アカウントを無効にした。
    詳細については、メソッド PolicyMgtUser>DisableByAdmin を参照してください。
  • アカウント非アクティブ状態が許可されている時間を超えました。
  • ログイン失敗の数が許可されている最大数を超えた。
    詳細については、メソッド PolicyMgtUser>DisableMaxLoginFail を参照してください。
  • パスワードが期限切れになった。
    詳細については、メソッド PolicyMgtUser>DisablePwdExpired を参照してください。
DisableMaxLoginFail メソッド - Disabled-by-Max-Login-Failure フラグを設定または取得
DisableMaxLoginFail メソッドは、disabled-by-max-login-failure フラグを設定または取得します。このフラグは、ログイン失敗の回数が許可されている最大数を超えたことを理由にユーザ アカウントが無効化されるかどうかを指定します。
構文
DisableMaxLoginFail メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->DisableMaxLoginFail([disableFlag])
[Parameters]
DisableMaxLoginFail メソッドは以下のパラメータを受け入れます。
  1. disableFlag
    (int)
    (オプション)disabled-by-max-login-failure フラグの新しい値を指定します。
    • 値 = 1
      ログイン失敗の回数が許可されている最大数を超えたことを理由にユーザ アカウントが無効化されることを指定します。
    • 値 = 0
      ログイン失敗の回数が許可されている最大数を超えてもユーザ アカウントが無効化されないことを指定します。
      : ユーザ アカウントは他の理由で無効になる場合があります。詳細については、「注釈」を参照してください。
戻り値
DisableMaxLoginFail メソッドは、以下のように disabled-by-max-login-failure フラグの新規または既存の値を返します。
  • 値 = 1
    ログイン失敗の回数が許可されている最大数を超えたことを理由にユーザ アカウントが無効化されることを指定します。
  • 値 = 0
    ログイン失敗の回数が許可されている最大数を超えてもユーザ アカウントが無効化され
    ない
    ことを指定します。
    : ユーザ アカウントは他の理由で無効になる場合があります。詳細については、「注釈」を参照してください。
  • 値 = -1
    コールが失敗したことを指定します。
注釈
ユーザ アカウントは以下の 1 つ以上の理由で無効になる場合があります。
  • 管理者がユーザ アカウントを無効にした。
    詳細については、メソッド PolicyMgtUser>DisableByAdmin を参照してください。
  • アカウント非アクティブ状態が許可されている時間を超えました。
    詳細については、メソッド PolicyMgtUser>DisableInactive を参照してください。
  • ログイン失敗の数が許可されている最大数を超えた。
  • パスワードが期限切れになった。
    詳細については、メソッド PolicyMgtUser>DisablePwdExpired を参照してください。
DisablePwdExpired メソッド - Disabled-by-Password-Expired フラグを設定または取得
DisablePwdExpired メソッドは、ユーザ アカウントがパスワードの期限切れを理由に無効化されるかどうかを指定する disabled-by-password-expired フラグを設定または取得します。
構文
DisablePwdExpired メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->DisablePwdExpired([disableFlag])
[Parameters]
DisablePwdExpired メソッドは以下のパラメータを受け入れます。
  1. disableFlag
    (int)
    (オプション)disabled-by-password-expired フラグの新しい値を指定します。
    • 値 = 1
      ユーザ アカウントがパスワードの期限切れを理由に無効化されることを指定します。
    • 値 = 0
      ユーザ アカウントがパスワードの期限切れを理由に無効化されないことを指定します。
    • : ユーザ アカウントは他の理由で無効になる場合があります。詳細については、「注釈」を参照してください。
戻り値
DisablePwdExpired メソッドは、以下のように disabled-by-password-expired フラグの新規または既存の値を返します。
  • 値 = 1
    ユーザ アカウントがパスワードの期限切れを理由に無効化されることを指定します。
  • 値 = 0
    ユーザ アカウントがパスワードの期限切れを理由に無効化され
    ない
    ことを指定します。
    : ユーザ アカウントは他の理由で無効になる場合があります。詳細については、「注釈」を参照してください。
  • 値 = -1
    コールが失敗したことを指定します。
注釈
ユーザ アカウントは以下の 1 つ以上の理由で無効になる場合があります。
  • 管理者がユーザ アカウントを無効にした。
    詳細については、メソッド PolicyMgtUser>DisableByAdmin を参照してください。
  • アカウント非アクティブ状態が許可されている時間を超えました。
    詳細については、メソッド PolicyMgtUser>DisableInactive を参照してください。
  • ログイン失敗の数が許可されている最大数を超えた。
    詳細については、メソッド PolicyMgtUser>DisableMaxLoginFail を参照してください。
  • パスワードが期限切れになった。
ForcePwdChange メソッド - Force-Password-Change フラグを設定または取得
ForcePwdChange メソッドは、次回のユーザ ログイン時にパスワード変更を強制するかどうかを指定する force-password-change フラグを設定または取得します。
構文
ForcePwdChange メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->ForcePwdChange([forceFlag])
[Parameters]
ForcePwdChange メソッドは以下のパラメータを受け入れます。
  1. forceFlag
    (int)
    (オプション)次回のユーザ ログイン時にパスワード変更を強制するかどうかを指定します。
    • 値 = 1
      次回のユーザ ログイン時にパスワード変更を強制することを指定します。
    • 値 = 0
      次回のユーザ ログイン時にパスワード変更を強制
      しない
      ことを指定します。
戻り値
ForcePwdChange メソッドは、force-password-change フラグの新規または既存の値を返します。
  • 値 = 1
    次回のユーザ ログイン時にパスワード変更を強制することを指定します。
  • 値 = 0
    次回のユーザ ログイン時にパスワード変更を強制
    しない
    ことを指定します。
  • 値 = -1
    コールが失敗したことを指定します。
GetClass メソッド - ユーザ クラスを取得
GetClass メソッドは、ユーザ クラスを取得します。
構文
GetClass メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->GetClass()
[Parameters]
GetClass メソッドは、パラメータを受け入れません。
戻り値
GetClass メソッドは以下のいずれかの値を返します。
  • user_class
    例:
    "organization"
  • コールに失敗した場合は、
    undef
SetPassword メソッド - 新しいパスワードを設定
SetPassword メソッドは、ユーザの新しいパスワードを設定します。
構文
SetPassword メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->SetPassword(newPwd[, oldPwd])
[Parameters]
SetPassword メソッドは、以下のパラメータを受け入れます。
  1. newPwd
    (文字列)
    新しいパスワードを指定します。
  2. oldPwd
    (文字列)
    (オプション)変更する古いパスワードを指定します。
    : 指定する場合、この値はユーザ ディレクトリ内の既存のパスワードに一致する必要があります。
戻り値
SetPassword メソッドは以下のいずれかの値を返します。
  • 値 = 0
    パスワードの変更が成功したことを指定します。
  • 値 = -1
    パスワードの変更が失敗したことを指定します。
UserPasswordState メソッド - パスワード状態オブジェクトを設定または取得
UserPasswordState メソッドは、現在のユーザのパスワード状態オブジェクトを設定または取得します。新しいパスワード状態オブジェクトを設定すると、オブジェクトの属性が更新され、実行した変更が反映されます。empty-history フラグで指定された場合、このメソッドはパスワード履歴もクリアします。
構文
UserPasswordState メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->UserPasswordState([pPwState][, emptyHistoryFlag])
[Parameters]
UserPasswordState メソッドは、以下のパラメータを受け入れます。
  1. pPwState
    (PolicyMgtUserPasswordState)
    (オプション)設定する新しいパスワード状態オブジェクトを指定します。
  2. emptyHistoryFlag
    (int)
    (オプション)パスワード履歴をクリアするかどうかを指定します。
    • 値 = 0(デフォルト)
      パスワード履歴をクリア
      しない
      ことを指定します。
    • 値 = 1
      パスワード履歴をクリアすることを指定します。
      : パスワード履歴をクリアすると、last-password-change-time 属性が 0 に設定されます。詳細については、メソッド PolicyMgtUserPasswordState>LastPWChangeTime を参照してください。
戻り値
UserPasswordState メソッドは以下のいずれかの値を返します。
  • PolicyMgtUserPasswordState (オブジェクト)
  • コールに失敗した場合は、
    undef
ValidatePassword メソッド - パスワードを検証
ValidatePassword メソッドは、ユーザ パスワードがパスワード ポリシーに適合するかどうかを判断します。SetPassword メソッドをコールする前に、ValidatePassword をコールします。
構文
ValidatePassword メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtUser->ValidatePassword(password)
[Parameters]
ValidatePassword メソッドは、以下のパラメータを受け入れます。
  1. password
    (文字列)
    (オプション)検証するパスワードを指定します。
戻り値
ValidatePassword メソッドは以下のいずれかの値を返します。
  • 値 = 0
    パスワードが有効であることを指定します。
  • 値 = -1
    パスワードが有効で
    ない
    ことを指定します。