CLI エージェント API ユーザ メソッド

ここでは、CLI エージェント API ユーザ メソッドについて説明します。
casso1283
ここでは、CLI エージェント API ユーザ メソッドについて説明します。
Audit メソッド -- エージェント キャッシュから実行された許可を監査
Audit メソッドは、エージェント キャッシュから実行された許可を監査します。
構文
Audit メソッドの形式は以下のとおりです。
Netegrity::AgentUser->Audit()
[Parameters]
Audit メソッドは、パラメータを受け入れません。
戻り値
Audit メソッドは以下のいずれかの値を返します。
  • SM_AGENTAPI_YES(値 = 1)
    監査が成功したことを指定します。
  • SM_AGENTAPI_NO(値 = 2)
    監査が成功しなかったことを指定します。
  • SM_AGENTAPI_FAILURE(値 = -1)
    ポリシー サーバに到達できなかったことを指定します。
  • SM_AGENTAPI_TIMEOUT(値 = -2)
    メソッドがタイムアウトしたことを指定します。
  • SM_AGENTAPI_NOCONNECTION(値 = -3)
    初期化が失敗したことを指定します。
Certificate メソッド -- ユーザの X.509 証明書を設定または取得
Certificate メソッドは、ユーザの X.509 証明書を設定または取得します。このメソッドは、ユーザ オブジェクトの現在のインスタンスと関連付けられた証明書データにのみ影響します。
構文
Certificate メソッドの形式は以下のとおりです。
Netegrity::AgentUser->Certificate([cert, certBinaryLen]) (returnCode)
[Parameters]
Certificate メソッドは、以下のパラメータを受け入れます。
  1. cert
    (文字列)
    (オプション)設定する証明書データを指定します。
  2. certBinaryLen
    (int)
    (オプション)証明書の長さを指定します。
  3. returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
Certificate メソッドは以下のいずれかの値を返します。
  • 新規または既存の証明書のデータおよび長さを指定する配列($String, $Length)。
CertificateFile メソッド -- ファイルを使用してユーザの X.509 証明書を設定または取得
CertificateFile メソッドは、指定された証明書ファイルを使用して、ユーザの X.509 証明書を設定または取得します。
構文
CertificateFile メソッドの形式は以下のとおりです。
Netegrity::AgentUser->CertificateFile([certFile[, format]] ) (returnCode)
[Parameters]
CertificateFile メソッドは、以下のパラメータを受け入れます。
  1. certFile
    (文字列)
    (オプション)証明書ファイルの完全パスおよびファイル名を指定します。
  2. format
    (文字列)
    (オプション)証明書ファイルの形式を指定します。
    デフォルト:
    base64 エンコード化 X.509(値 = 1)
    注:
    デフォルトはサポートされているファイル形式のみです。
  3. returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
CertificateFile メソッドは、以下の値を返します。
  • 新規または既存の証明書のデータおよび長さを指定する配列($String, $Length)。
CreateSSOToken メソッド -- シングル サインオン トークン オブジェクトを作成
CreateSSOToken メソッドは、有効なユーザ セッションからシングル サインオン トークン オブジェクトを作成します。トークンには、カスタム エージェントが標準の
SiteMinder
Web エージェントと共有できる暗号化されたセッションおよびその他の情報が含まれます。標準とカスタムのエージェント間のシングル サインオンを作成するには、エージェントが同じドメインに存在する必要があります。シングル サインオン オブジェクトを作成するには、ユーザは
SiteMinder
エージェントではなくカスタム エージェントにログインする必要があります。
構文
CreateSSOToken メソッドの形式は以下のとおりです。
Netegrity::AgentUser->CreateSSOToken(szDn, szName, szIP)
[Parameters]
CreateSSOToken メソッドは、以下のパラメータを受け入れます。
  1. szDn
    (文字列)
    ユーザの識別名を指定します。
  2. szName
    (文字列)
    ユーザの名前を指定します。
  3. szIP
    (文字列)
    保護されているリソースの要求をユーザが開始したマシンの IP アドレスを指定します。
戻り値
CreateSSOToken メソッドは、以下の値を返します。
  • SSOToken (オブジェクト)
注釈
トークン オブジェクトを文字列形式で取得するには、GetString メソッドを使用して、トークン文字列を SMSESSION Cookie に書き込みます。トークンをデコードするには、その属性のサブセットを取得して Decode メソッドを使用します。
CustomData メソッド -- カスタム認証データを設定または取得
CustomData メソッドは、カスタム認証データを設定または取得します。このメソッドはカスタム テンプレートに基づく認証方式をテストするために使用されます。カスタム認証データの形式およびコンテンツは、各 Web サイトの要件に従ってカスタマ定義されます。
構文
CustomData メソッドの形式は以下のとおりです。
Netegrity::AgentUser->CustomData([customData, length]) (returnCode)
[Parameters]
CustomData メソッドは、以下のパラメータを受け入れます。
  1. customData
    (文字列)
    (オプション)設定するカスタム認証データを指定します。
  2. length
    (int)
    (オプション)カスタム認証データの長さを指定します。
  3. returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
CustomData メソッドは以下のいずれかの値を返します。
  • 新規または既存のカスタム データおよび長さを指定する配列($String, $Length)。
FormData メソッド -- HTML フォームベースの認証データを設定または取得
FormData メソッドは、HTML フォームベースの認証データを設定または取得します。このメソッドは HTML フォーム テンプレートに基づく認証方式をテストするために使用されます。formData 文字列は、アンパサンド(&)文字によって区切られた属性名と値のペアから構成されます。
"PASSWORD=$password1&[email protected]"
構文
FormData メソッドの形式は以下のとおりです。
Netegrity::AgentUser->FormData([formData])
[Parameters]
FormData メソッドは以下のパラメータを受け入れます。
  1. formData
    (文字列)
    (オプション)設定する HTML フォームベースの認証データを指定します。
戻り値
FormData メソッドは以下のいずれかの値を返します。
  • authentication_data
    新規または既存の HTML フォームベースの認証データを指定します。
  • undef
    メソッドが失敗したことを指定します。
GetResponse メソッド -- IsAuthorized または Login 後のレスポンスを返す
GetResponse メソッドは、AgentUser->IsAuthorized または AgentUser->Login のコール後に、ユーザが許可されているかどうかに関係なく、レスポンスを返します。
構文
GetResponse メソッドの形式は以下のとおりです。
Netegrity::AgentUser->GetResponse()
[Parameters]
GetResponse メソッドは、パラメータを受け入れません。
戻り値
GetResponse メソッドは以下のいずれかの値を返します。
  • AgentResponse (オブジェクト)
  • undef
    GetResponse をコールする前に AgentUser->IsAuthorized または AgentUser->Login をコールしなかったために、メソッドが失敗したことを指定します。
Impersonate メソッド -- 1 人のユーザが別のユーザに偽装することを許可
Impersonate メソッドは、そのユーザとしてログインして、1 人のユーザが別のユーザに偽装できるようにします。たとえば、顧客サービス担当者は、顧客のソフトウェア問題をよりよく理解するために顧客に偽装することができます。
構文
Impersonate メソッドの形式は以下のとおりです。
Netegrity::AgentUser->Impersonate(username, resource)
[Parameters]
Impersonate メソッドは、以下のパラメータを受け入れます。
  1. username
    (文字列)
    偽装するユーザの ID を指定します。
  2. resource
    (AgentResource オブジェクト)
    ログインするリソースを指定します。
戻り値
Impersonate メソッドは以下のいずれかの値を返します。
  • SM_AGENTAPI_YES(値 = 1)
    偽装に成功したことを指定します。
  • SM_AGENTAPI_NO(値 = 2)
    偽装に失敗したことを指定します。
  • SM_AGENTAPI_FAILURE(値 = -1)
    操作が失敗したことを指定します。
  • SM_AGENTAPI_TIMEOUT(値 = -2)
    メソッドがタイムアウトしたことを指定します。
  • SM_AGENTAPI_NOCONNECTION(値 = -3)
    初期化が失敗したことを指定します。
注釈
Impersonate メソッドは、偽装する人の元のセッションを破壊せずに、新しいセッションを作成します。インパーソネーション セッションを終了し、偽装する人の元のセッションをリストアするには、AgentUser->Logout をコールします。
偽装する対象にできるユーザは 1 回に 1 人のみです。インパーソネーション セッションを連鎖させることはできません。
インパーソネーションは、Impersonation Authorization Scheme によって保護されるレルムで開始します。偽装する人は、レルムのユーザに偽装することを許可されている必要があります。また、ユーザはレルム内で偽装することの対象として許可されている必要があります。
IsAuthorized メソッド -- ユーザが許可されるかどうかを判定
IsAuthorized メソッドは、指定されたリソース上で指定されたアクションを実行する権限がユーザに与えられているかどうかを判定します。このメソッドが AgentUser->Login をコールするのは AgentUser->Login がコールされていない場合です。このメソッドをコールした後に、AgentUser->GetResponse をコールします。
構文
IsAuthorized メソッドの形式は以下のとおりです。
Netegrity::AgentUser->IsAuthorized(resource[, clientIP][, transID])
[Parameters]
IsAuthorized メソッドは、以下のパラメータを受け入れます。
  1. resource
    (AgentResource オブジェクト)
    確認するリソースを指定します。
  2. clientIP
    (文字列)
    (オプション)クライアントの IP アドレスを指定します。
  3. transID
    (文字列)
    (オプション)セキュリティ アクティビティとアプリケーション アクティビティを関連付けるためにエージェントが使用するユーザ定義のトランザクション ID を指定します。
戻り値
IsAuthorized メソッドは以下のいずれかの値を返します。
  • SM_AGENTAPI_YES(値 = 1)
    ユーザが許可されることを指定します。
  • SM_AGENTAPI_NO(値 = 2)
    ユーザが許可されないことを指定します。
  • SM_AGENTAPI_FAILURE(値 = -1)
    ポリシー サーバに到達できなかったことを指定します。
  • SM_AGENTAPI_TIMEOUT(値 = -2)
    メソッドがタイムアウトしたことを指定します。
  • SM_AGENTAPI_NOCONNECTION(値 = -3)
    初期化が行われなかったことを指定します。
IsAuthorizedEx メソッド -- ユーザが許可されるかどうかを判定
IsAuthorizedEx メソッドは、指定されたリソース上で指定されたアクションを実行する権限がユーザに与えられているかどうかを判定します。このメソッドが AgentUser->Login をコールするのは AgentUser->Login がコールされていない場合です。このメソッドをコールした後に、AgentUser->GetResponse をコールします。
構文
IsAuthorizedEx メソッドの形式は以下のとおりです。
Netegrity::AgentUser->IsAuthorizedEx(resource[, clientIP][, transID])
[Parameters]
IsAuthorizedEx メソッドは、以下のパラメータを受け入れます。
  1. resource
    (AgentResource オブジェクト)
    確認するリソースを指定します。
  2. clientIP
    (文字列)
    (オプション)クライアントの IP アドレスを指定します。
  3. transID
    (文字列)
    (オプション)セキュリティ アクティビティとアプリケーション アクティビティを関連付けるためにエージェントが使用するユーザ定義のトランザクション ID を指定します。
戻り値
IsAuthorizedEx メソッドは以下のいずれかの値を返します。
  • SM_AGENTAPI_YES(値 = 1)
    ユーザが許可されることを指定します。
  • SM_AGENTAPI_NO(値 = 2)
    ユーザが許可されないことを指定します。
  • SM_AGENTAPI_FAILURE(値 = -1)
    ポリシー サーバに到達できなかったことを指定します。
  • SM_AGENTAPI_TIMEOUT(値 = -2)
    メソッドがタイムアウトしたことを指定します。
  • SM_AGENTAPI_NOCONNECTION(値 = -3)
    初期化が行われなかったことを指定します。
Login メソッド -- セッション ログインおよび検証を実行
Login メソッドは、セッション ログインおよび検証を実行します。このメソッドをコールする前に、ターゲット リソース に対し AgentResource->IsProtected をコールします。
構文
Login メソッドの形式は以下のとおりです。
Netegrity::AgentUser->Login(resource[, clientIP])
[Parameters]
Login メソッドは、以下のパラメータを受け入れます。
  1. resource
    (AgentResource オブジェクト)
    ログインするリソースを指定します。
  2. clientIP
    (文字列)
    (オプション)クライアントの IP アドレスを指定します。
戻り値
Login メソッドは以下のいずれかの値を返します。
  • SM_AGENTAPI_YES(値 = 1)
    ユーザ ログインに成功したことを指定します。
  • SM_AGENTAPI_NO(値 = 2)
    ユーザ ログインに失敗したことを指定します。
  • SM_AGENTAPI_CHALLENGE(値 = 3)
    認証にチャレンジが必要であることを指定します。
  • SM_AGENTAPI_FAILURE(値 = -1)
    操作が失敗したことを指定します。
  • SM_AGENTAPI_TIMEOUT(値 = -2)
    メソッドがタイムアウトしたことを指定します。
  • SM_AGENTAPI_NOCONNECTION(値 = -3)
    オブジェクトが接続されなかったことを指定します。
注釈
すでにログインしている 1 人のユーザが別のユーザとして再度ログインできるようにするには、AgentUser->Impersonate をコールします。
Logout メソッド -- ユーザをセッションからログアウト
Logout メソッドは、ユーザをセッションからログアウトします。このメソッドはオプションとしてコールします。ユーザ オブジェクトが Perl スクリプトでその範囲を超えると、ユーザは自動的にログアウトされます。
構文
Logout メソッドの形式は以下のとおりです。
Netegrity::AgentUser->Logout()
[Parameters]
Logout メソッドは、パラメータを受け入れません。
戻り値
Logout メソッドは以下のいずれかの値を返します。
  • SM_AGENTAPI_YES(値 = 1)
    ユーザが正しくログアウトされたことを指定します。
  • SM_AGENTAPI_NO(値 = 2)
    ユーザ ログアウトに失敗したことを指定します。
  • SM_AGENTAPI_CHALLENGE(値 = 3)
    認証にチャレンジが必要であることを指定します。
  • SM_AGENTAPI_FAILURE(値 = -1)
    操作が失敗したことを指定します。
  • SM_AGENTAPI_TIMEOUT(値 = -2)
    メソッドがタイムアウトしたことを指定します。
  • SM_AGENTAPI_NOCONNECTION(値 = -3)
    オブジェクトが接続されなかったことを指定します。
注釈
1 人のユーザが別のユーザに偽装している間に Logout をコールすると、インパーソネーション セッションが終了し、偽装する人の元のセッションがリストアされます。AgentUser->Impersonate をコールすると、1 人のユーザが別のユーザに偽装するか、別のユーザとしてログインできます。
Name メソッド -- ユーザのユーザ名を設定または取得
Name メソッドは、ユーザのユーザ名を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::AgentUser->Name([username])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
  1. username
    (文字列)
    (オプション)設定するユーザ名を指定します。
戻り値
Name メソッドは、以下の値を返します。
  • username(文字列)
    新規または既存のユーザ名を指定します。
注釈
ユーザ名の設定は、ユーザ オブジェクトの現在のインスタンスにのみ影響します。ディレクトリ内のユーザのエントリには影響しません。
Password メソッド -- ユーザのパスワードを設定または取得
Password メソッドは、ユーザのパスワードを設定または取得します。
構文
Password メソッドの形式は以下のとおりです。
Netegrity::AgentUser->Password([password])
[Parameters]
Password メソッドは以下のパラメータを受け入れます。
  1. password
    (文字列)
    (オプション)設定するパスワードを指定します。
戻り値
Password メソッドは、以下の値を返します。
  • password(文字列)
    新規または既存のパスワードを指定します。
注釈
パスワードの設定は、ユーザ オブジェクトの現在のインスタンスにのみ影響します。ディレクトリ内のユーザのエントリには影響しません。
Validate メソッド -- セッション指定情報を検証
Validate メソッドはユーザ セッションが期限切れになっていないか、終了または無効になっていないかを確認して、セッション指定情報を検証します。この確認は、セッションの存続中に随時に行われる場合があります。
構文
Validate メソッドの形式は以下のとおりです。
Netegrity::AgentUser->Validate(resource[, clientIP][, transID])
[Parameters]
Validate メソッドは、以下のパラメータを受け入れます。
  1. resource
    (AgentResource オブジェクト)
    ログインするリソースを指定します。
  2. clientIP
    (文字列)
    (オプション)クライアントの IP アドレスを指定します。
  3. transID
    (文字列)
    (オプション)ユーザ定義のトランザクション ID を指定します。
戻り値
Validate メソッドは以下のいずれかの値を返します。
  • SM_AGENTAPI_YES(値 = 1)
    操作に成功したことを指定します。
  • SM_AGENTAPI_NO(値 = 2)
    ユーザがログインされなかったことを指定します。
  • SM_AGENTAPI_FAILURE(値 = -1)
    操作が失敗したことを指定します。
  • SM_AGENTAPI_TIMEOUT(値 = -2)
    メソッドがタイムアウトしたことを指定します。
  • SM_AGENTAPI_NOCONNECTION(値 = -3)
    オブジェクトが接続されなかったことを指定します。
注釈
ポリシー サーバはセッション指定情報またはセッション ID を以下のように検証します。
  • セッション ID がセッション指定情報なしで指定される場合、ポリシー サーバは検証用のセッション ID を使用します。
  • セッション ID がセッション指定情報と共に指定される場合、ポリシー サーバはセッション指定情報に対してセッション ID を検証します。
  • クライアントの IP アドレスがセッション指定情報と共に指定される場合、ポリシー サーバはセッション指定情報に対して IP アドレスを検証します。