CLI セッション メソッド
ここでは、CLI セッション メソッドについて説明します。
casso127jpjp
ここでは、CLI セッション メソッドについて説明します。
AddAttributeToSAMLScheme メソッド - 認証方式定義に新しい属性を追加
AddAttributeToSAMLScheme メソッドは、SAML 2.0 認証方式定義に新しい属性を追加します。
構文
AddAttributeToSAMLScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->AddAttributeToSAMLScheme(scheme, AttrNameFormat, LocalName, Name)
Arguments
AddAttributeToSAMLScheme メソッドは、以下の引数を受け入れます。
- scheme(PolicyMgtAuthScheme オブジェクト)SAML 2.0 認証方式を指定します。
- AttrNameFormat(int)以下の属性タイプを指定します。
- SAMLSP_UNSPECIFIED
- SAMLSP_URI
- SAMLSP_BASIC
- LocalName(文字列)ローカルに使用されるとおりの属性の名前を指定します。
- Name(文字列)属性認証機関で定義されるとおりの属性の名前を指定します。
戻り値
AddAttributeToSAMLScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtSAMLRequesterAttr(オブジェクト)
- コールに失敗した場合は、undef
AddTrustedHost メソッド - トラステッド ホスト オブジェクトを作成または変更
AddTrustedHost メソッドは、ポリシー ストア内のトラステッド ホスト オブジェクトを作成または変更します。
構文
AddTrustedHost メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->AddTrustedHost(trustedHostName[, trustedHostDescription][, trustedHostIpAddress][, sharedSecret])
Arguments
AddTrustedHost メソッドは、以下の引数を受け入れます。
- trustedHostName(文字列)トラステッド ホストの名前を指定します。
- trustedHostDescription(文字列)(オプション)トラステッド ホストの説明を指定します。
- trustedHostIpAddress(文字列)(オプション)トラステッド ホストの IP アドレスを指定します。
- sharedSecret(文字列)(オプション)共有秘密キーを指定します。注:また、-sh オプションを指定してCA Single Sign-onツール smreghost を実行することにより、ホスト設定ファイルで共有秘密キーを定義する必要があります。-sh オプションを使用して共有秘密キーを指定しない場合は、CA Single Sign-onによって自動的に生成されます。
戻り値
AddTrustedHost メソッドは以下のいずれかの値を返します。
- PolicyMgtTrustedHost(オブジェクト)
- トラステッド ホスト名がすでに存在する場合は、undef
注釈
AddTrustedHost メソッドを使用してトラステッド ホストを登録する場合は、最初にポリシー サーバとエージェント間の接続を設定する必要はありません。このメソッドを使用してトラステッド ホストを登録するときは、ホスト設定ファイルで共有秘密キーを定義するために
CA Single Sign-on
ツール smreghost を実行する必要もあります。(ホスト設定ファイルはデフォルトでは SmHost.conf と呼ばれます)。-sh オプションおよび共有秘密キーを指定して smreghost を実行します。共有秘密キーをクリア テキストで取得するには、メソッド PolicyMgtTrustedHost->GetSecret をコールします。または、-sh オプションなしでメソッド CreateTrustedHost をコールして smreghost を実行し、トラステッド ホストを作成できます。この場合、
CA Single Sign-on
は、インストール時にトラステッド ホストを自動的に作成して設定します。重要:
CA Single Sign-on
はランダムな 128 バイト ASCII 共有秘密キーを生成します。共有秘密キーを作成するときは、任意の文字列値にできます。強力な共有秘密キーを作成するには、sharedSecret
パラメータを空の文字列に設定した状態で AddTrustedHost メソッドをコールすることを強く推奨します。これにより、ランダムで長く推測困難な共有秘密キーが自動的に生成されます。CreateAdmin メソッド - システムレベル管理者を作成
CreateAdmin メソッドは、システムレベル管理者を作成および設定します。
構文
CreateAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateAdmin(adminName[, adminDesc][, adminPwd][, userDir][, authScheme])
Arguments
CreateAdmin メソッドは、以下の引数を受け入れます。
- adminName(文字列)管理者の名前を指定します。
- adminDesc(文字列)(オプション)管理者の説明を指定します。
- adminPwd(文字列)(オプション)管理者のパスワードを指定します。
- userDir(PolicyMgtUserDir オブジェクト)(オプション)管理者が外部ディレクトリに保存される場合は、ユーザ ディレクトリを指定します。
- authScheme(PolicyMgtAuthScheme オブジェクト)(オプション)管理者が外部ディレクトリに保存される場合は、使用する認証方式を指定します。注: 外部ユーザ ディレクトリを指定する場合は、このパラメータが必要です。
戻り値
CreateAdmin メソッドは以下のいずれかの値を返します。
- PolicyMgtAdmin(オブジェクト)
- コールに失敗した場合または管理者名がすでに存在する場合は、undef
注釈
ポリシー管理 API では、特定のドメインの管理者を作成できません。ただし、メソッド AddAdmin をコールすることにより、特定のドメインに既存の管理者を追加できます。ドメイン権限がある管理者を作成するには、管理 UI を使用します。
CreateAffDomain メソッド - アフィリエイト ドメインを作成
CreateAffDomain メソッドは、アフィリエイト ドメインを作成します。
構文
CreateAffDomain メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateAffDomain(domName[, domDesc])
Arguments
CreateAffDomain メソッドは、以下の引数を受け入れます。
- domName(文字列)アフィリエイト ドメインの名前を指定します。
- domDesc(文字列)(オプション)アフィリエイト ドメインの説明を指定します。
戻り値
CreateAffDomain メソッドは以下のいずれかの値を返します。
- PolicyMgtAffDomain(オブジェクト)
- コールに失敗した場合またはアフィリエイト ドメイン名がすでに存在する場合は、undef
注釈
アフィリエイト ドメインを実装するには、eTrust
CA Single Sign-on
FSS が必要です。CreateAgent メソッド -
CA Single Sign-on
エージェントを作成CreateAgent メソッドは、
CA Single Sign-on
エージェントを作成および設定します。構文
CreateAgent メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateAgent(agentName, agentType[, agentDesc][, agentIP][, agentSecret][, realmHintAttrID])
Arguments
CreateAgent メソッドは、以下の引数を受け入れます。
- agentName(文字列)エージェントの名前を指定します
- agentType(PolicyMgtAgentType オブジェクト)エージェントのタイプを指定します。
- agentDesc(文字列)(オプション)エージェントの説明を指定します。
- agentIP(文字列)(オプション)エージェントの IP アドレスを指定します。注: このパラメータは、RADIUS エージェントにとって必須です。
- agentSecret(文字列)(オプション)共有秘密キーを指定します。注: v4.x エージェントを作成するには、共有秘密キーを指定します。v5.x エージェントを作成するには、このパラメータを省略します。
- realmHintAttrID(int)(オプション)レルム ヒント属性 ID を指定します。注: このパラメータは RADIUS エージェントにのみ適用されます。
戻り値
CreateAgent メソッドは以下のいずれかの値を返します。
- PolicyMgtAgent(オブジェクト)
- コールに失敗した場合または エージェント名がすでに存在する場合は、undefCA Single Sign-on
CreateAgentConfig メソッド - エージェント設定オブジェクトを作成
CreateAgentConfig メソッドは、エージェント設定オブジェクトを作成します。
構文
CreateAgentConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateAgentConfig(agentConfigName[, AgentConfigDesc])
Arguments
CreateAgentConfig メソッドは、以下の引数を受け入れます。
- agentConfigName(文字列)エージェント設定の名前を指定します。
- AgentConfigDesc(文字列)(オプション)エージェント設定の説明を指定します。
戻り値
CreateAgentConfig メソッドは以下のいずれかの値を返します。
- PolicyMgtAgentConfig(オブジェクト)
- コールに失敗した場合またはエージェント設定名がすでに存在する場合は、undef
CreateAgentGroup メソッド - エージェント グループを作成
CreateAgentGroup メソッドは、エージェント グループを作成します。
構文
CreateAgentGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateAgentGroup(agentGroupName, agentType[, groupDesc])
Arguments
CreateAgentGroup メソッドは、以下の引数を受け入れます。
- agentGroupName(文字列)エージェント グループの名前を指定します。
- agentType(PolicyMgtAgentType オブジェクト)エージェント グループと関連付けられたエージェントのタイプを指定します。注: このメソッドのエージェント タイプを取得するには、メソッド PolicyMgtSession->GetAgentType をコールします。
- groupDesc(文字列)(オプション)エージェント グループの説明を指定します。
戻り値
CreateAgentGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup(オブジェクト)
- エージェント グループ名がすでに存在する場合は、undef
CreateAuthAzMap メソッド - マッピング オブジェクトを作成
CreateAuthAzMap メソッドは、認証および許可ディレクトリ マッピング オブジェクトを作成します。
構文
CreateAuthAzMap メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateAuthAzMap(authDir, azDir, mapType)
Arguments
CreateAuthAzMap メソッドは、以下の引数を受け入れます。
- authDir(PolicyMgtUserDir オブジェクト)ユーザを認証するときに使用するユーザ ディレクトリを指定します。
- azDir(PolicyMgtUserDir オブジェクト)ユーザを許可するときに使用するユーザ ディレクトリを指定します。
- mapType(int)ディレクトリ マッピングのタイプを指定します。
- AUTHAZMAPTYPE_DN(値=1)DN に基づいてマッピングを指定します。
- AUTHAZMAPTYPE_UNIVERSALID(値=2)ユニバーサル識別子に基づいてマッピングを指定します。
- AUTHAZMAPTYPE_ATTR(値=3)ユーザ ディレクトリ内の属性に基づいてマッピングを指定します。
戻り値
CreateAuthAzMap メソッドは以下のいずれかの値を返します。
- PolicyMgtAuthAzMap(オブジェクト)
- コールに失敗した場合は、undef
注釈
CA Single Sign-on
は、ユーザを認証し認可するために同じユーザ ディレクトリを使用します。さらに、CA Single Sign-on
では、認証用に 1 つのユーザ ディレクトリおよび許可用に別のユーザ ディレクトリを指定できます。この機能をディレクトリ マッピングといいます。認証情報がセントラル ディレクトリに保存され、許可情報が複数のディレクトリに保存されて、それぞれが特定のアプリケーションに関連付けられる場合に、ディレクトリ マッピングは特に役立ちます。CreateAuthScheme メソッド - 認証方式を作成
CreateAuthScheme メソッドは、認証方式を作成および設定します。
構文
CreateAuthScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateAuthScheme(schemeName, schemeTemplate[, schemeDesc][, protLevel][, schemeLib][, schemeParam][, secret][, isTemplate][, isUsedByAdmin][, saveCreds][, isRadius][, ignorePwd])
Arguments
CreateAuthScheme メソッドは、以下の引数を受け入れます。
- schemeName(文字列)認証方式の名前を指定します。
- schemeTemplate(PolicyMgtAuthScheme オブジェクト)(オプション)認証方式のベースにするテンプレートを指定します。注: テンプレートのリストを表示するには、メソッド PolicyMgtSession>GetAuthScheme を参照してください。
- schemeDesc(文字列)(オプション)認証方式タイプの説明を指定します。
- protLevel(int)(オプション)認証方式の保護レベルを指定します。範囲: 1 ~ 1000注: 保護レベルの値が高いほど、認証方式のセキュリティ レベルが高くなります。
- schemeLib(文字列)(オプション)各タイプの認証方式と共にリリースされるデフォルト ライブラリの代わりに使用する、カスタム ライブラリの名前を指定します。
- schemeParam(文字列)(オプション)認証方式に渡すパラメータ文字列を指定します。注: パラメータ文字列を構築しやすくするため、管理 UI で[認証方式プロパティ]ダイアログ ボックスの[方式タイプのセットアップ]タブに移動します。認証方式タイプを選択し、フィールドに値を入力して、[詳細]タブ上で結果を確認します。
- secret(文字列)(オプション)認証方式の共有秘密キーを指定します。
- isTemplate(int)(オプション)認証方式が他の認証方式用のテンプレートかどうかを指定します。デフォルト: ゼロ(0)値は、認証方式がテンプレートでないことを指定します。注:このパラメータはSingle Sign-Onv6.0 SP3 以降廃止されました。
- isUsedByAdmin(int)(オプション)認証方式を使用して、管理者を認証できるかどうかを指定します。
- saveCreds(int)(オプション)ユーザ認証情報を保存するかどうかを指定します。
- isRadius(int)(オプション)認証方式タイプが RADIUS かどうかを指定します。
- ignorePwd(int)(オプション)パスワード ポリシーを無視するかどうかを指定します。
戻り値
CreateAuthScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtAuthScheme(オブジェクト)
- コールに失敗した場合または認証方式名がすでに存在する場合は、undef
CreateCustomCertMap メソッド - カスタム証明書マップを作成
CreateCustomCertMap メソッドは、カスタム証明書マップを作成します。カスタム証明書マップは、証明書の Subject DN で定義されたユーザ属性名と、ユーザ ディレクトリ内の対応するユーザ属性名を関連付けます。認証に成功するには、マップされたユーザ属性ペアの値が一致する必要があります。マップされる属性名を定義するために
AttributeMap
パラメータを使用します。構文
CreateCustomCertMap メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateCustomCertMap(IssuerDN, AttributeMap[, DirectoryType])
Arguments
CreateCustomCertMap メソッドは、以下の引数を受け入れます。
- IssuerDN(文字列)証明書発行者の識別名を指定します。
- AttributeMap(文字列)ユーザ ディレクトリ内の属性名に証明書の Subject DN 内の属性名をマップする式を指定します。構文: UserAttrName1=%{CertAttrName1},UserAttrName2=%{CertAttrName2}, . . . UserAttrName#=%{CertAttrName#}例:証明書の Subject DN の内容: CN=John Smith, UID=JSMITH, OU=Development, O=CompanyAAttributeMapの内容: CN=%{UID}, OU=%{OU}, O=%{O}ユーザ ディレクトリで一致するユーザ DN: CN=JSMITH, OU=Development, O=CompanyA
- DirectoryType(int)(オプション)以下のように、認証ディレクトリとして指定されるユーザ ディレクトリのタイプを指定します。
- Sm_PolicyApi_DirType_LDAP注: これがデフォルトです。
- Sm_PolicyApi_DirType_WinNT
- Sm_PolicyApi_DirType_ODBC
戻り値
CreateCustomCertMap メソッドは以下のいずれかの値を返します。
- PolicyMgtCertMap(オブジェクト)
- コールに失敗した場合は、undef
注釈
証明書マップが作成されると、以下のフラグがデフォルト値である false に設定されます。
- certificate_required_flag
- use_distributionpoints_flag
- verify_signature_flag
- check_certificate_revocation_list_flag
- cache_certificate_revocation_list_entries_flag
これらのフラグの値の変更の詳細については、メソッド PolicyMgtSession>CreateExactCertMap を参照してください。
CreateDomain メソッド - ポリシー ドメイン オブジェクトを作成
CreateDomain メソッドは、ポリシー ドメイン オブジェクトを作成します。
構文
CreateDomain メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateDomain(domName[, domDesc][, globalPoliciesApply])
Arguments
CreateDomain メソッドは、以下の引数を受け入れます。
- domName(文字列)ドメインの名前を指定します。
- domDesc(文字列)(オプション)ドメインの説明を指定します。
- globalPoliciesApply(int)(オプション)ドメインでグローバル ポリシーを受け入れられるかどうかを指定します。
- 値 = 1(デフォルト)ドメインでグローバル ポリシーを受け入れられることを指定します。
- 値 = 0ドメインでグローバル ポリシーを受け入れられないことを指定します。
戻り値
CreateDomain メソッドは以下のいずれかの値を返します。
- PolicyMgtDomain(オブジェクト)
- コールに失敗した場合またはポリシー ドメイン名がすでに存在する場合は、undef
CreateExactCertMap メソッド - ユーザ ディレクトリ属性に一致する証明書マップを作成
CreateExactCertMap メソッドは、その Subject DN 属性が対応するユーザ ディレクトリ属性に正確に一致する証明書マップ オブジェクトを作成します。証明書マップ オブジェクトが作成されるときに、以下のフラグが FALSE に設定されます。
- 証明書は必要注: このフラグの値を変更するには、メソッド PolicyMgtCertMap->CertRequired をコールします。
- 配布ポイントを使用注: このフラグの値を変更するには、メソッド PolicyMgtCertMap->UseDistributionPoints をコールします。
- 署名を確認注: このフラグの値を変更するには、メソッド PolicyMgtCertMap->VerifySignature をコールします。
- (CRL)をチェック注: このフラグの値を変更するには、メソッド PolicyMgtCertMap->EnableCRL をコールします。
- CRL エントリをキャッシュに入れる注: このフラグの値を変更するには、メソッド PolicyMgtCertMap->CacheCRL をコールします。
構文
CreateExactCertMap メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateExactCertMap(IssuerDN[, DirectoryType])
Arguments
CreateExactCertMap メソッドは、以下の引数を受け入れます。
- IssuerDN(文字列)証明書発行者の識別名を指定します。
- DirectoryType(int)(オプション)認証に使用する以下のいずれかのタイプのユーザ ディレクトリを指定します。
- Sm_PolicyApi_DirType_LDAP(デフォルト)
- Sm_PolicyApi_DirType_WinNT
- Sm_PolicyApi_DirType_ODBC
戻り値
CreateExactCertMap メソッドは以下のいずれかの値を返します。
- PolicyMgtCertMap(オブジェクト)
- コールに失敗した場合は、undef
CreateGlobalPolicy メソッド - グローバル ポリシーを作成
CreateGlobalPolicy メソッドは、グローバル範囲を持つポリシーを作成します。
構文
CreateGlobalPolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateGlobalPolicy(policyName[, enableFlag][, activeExpr][, policyDesc])
Arguments
CreateGlobalPolicy メソッドは、以下の引数を受け入れます。
- policyName(文字列)グローバル ポリシーの名前を指定します。
- enableFlag(タイプ)(オプション)グローバル ポリシーを有効にするかどうかを指定します。
- 値 = 1(デフォルト)グローバル ポリシーを有効にすることを指定します。
- 値 = 0グローバル ポリシーを無効にすることを指定します。
- activeExpr(文字列)(オプション)... を指定します。
- policyDesc(文字列)(オプション)グローバル ポリシーの説明を指定します。
戻り値
CreateGlobalPolicy メソッドは以下のいずれかの値を返します。
- PolicyMgtPolicy(オブジェクト)
- コールに失敗した場合は、undef
CreateGlobalResponse メソッド - グローバル レスポンスを作成
CreateGlobalResponse メソッドは、グローバル範囲を持つレスポンスを作成します。
構文
CreateGlobalResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateGlobalResponse(respName, agentType[, respDesc])
Arguments
CreateGlobalResponse メソッドは、以下の引数を受け入れます。
- respName(文字列)グローバル レスポンスの名前を指定します。
- agentType(PolicyMgtAgentType オブジェクト)グローバル レスポンスと関連付けられたエージェントのタイプを指定します。注: エージェント タイプ オブジェクトを取得するには、メソッド PolicyMgtSession->GetAgentType をコールします。
- respDesc(文字列)(オプション)グローバル レスポンスの説明を指定します。
戻り値
CreateGlobalResponse メソッドは以下のいずれかの値を返します。
- PolicyMgtResponse(オブジェクト)
- コールに失敗した場合は、undef
CreateGlobalResponseGroup メソッド -- ドメイン固有のルール グループを作成
CreateGlobalResponseGroup メソッドは、特定のドメインに固有なルール グループを作成します。
構文
CreateGlobalResponseGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateGlobalResponseGroup(groupName, agentType, domain)
Arguments
CreateGlobalResponseGroup メソッドは、以下の引数を受け入れます。
- groupName(文字列)グローバル ルール グループ名を指定します。
- agentType(PolicyMgtAgentType)エージェントのタイプを指定します。
- domain(PolicyMgtDomain)ルール グループを適用するためのドメインを指定します。
戻り値
CreateGlobalResponseGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup(オブジェクト)
- コールに失敗した場合は、undef
CreateGlobalRule メソッド - グローバル ルールを作成
CreateGlobalRule メソッドは、グローバル範囲を持つルールを作成します。
構文
CreateGlobalRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateGlobalRule(ruleName, resource, event, agent[, ruleDesc][, allowAccess][, regexMatch][, activeExpr][, isEnabled])
Arguments
CreateGlobalRule メソッドは、以下の引数を受け入れます。
- ruleName(文字列)グローバル ルールの名前を指定します。
- resource(文字列)グローバル ルールが保護しているリソース用のフィルタを指定します。
- event(文字列)(オプション)ルールが実行されるイベントのタイプを指定します。
- agent(PolicyMgtAgent | PolicyMgtGroup)グローバル ルールと関連付けるエージェントまたはエージェント グループを指定します。
- ruleDesc(文字列)(オプション)グローバル ルールの説明を指定します。
- allowAccess(int)(オプション)以下のように、ルールによって保護されたリソースへのアクセスを許可または拒否するかどうかを指定します。
- 値 = 1(デフォルト)アクセスを許可することを指定します。
- 値 = 0アクセスを拒否することを指定します。
- regexMatch(int)(オプション)正規表現パターン一致を実行するかどうかを指定します。
- 値 = 1正規表現パターン一致を実行することを指定します。
- 値 = 0(デフォルト)正規表現パターン一致を実行しないことを指定します。
- activeExpr(文字列)(オプション)グローバル ルールのアクティブな式を指定します。
- isEnabled(int)(オプション)以下のようにグローバル ルールを有効または無効にするかどうかを指定します。
- 値 = 1(デフォルト)グローバル ルールを有効にすることを指定します。
- 値 = 0グローバル ルールを無効にすることを指定します。
戻り値
CreateGlobalRule メソッドは以下のいずれかの値を返します。
- PolicyMgtRule(オブジェクト)
- コールに失敗した場合は、undef
CreateGlobalRuleGroup メソッド -- ドメイン固有のルール グループを作成
CreateGlobalRuleGroup メソッドは、特定のドメインに固有なルール グループを作成します。
構文
CreateGlobalRuleGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateGlobalRuleGroup(groupName, agentType, domain)
Arguments
CreateGlobalRuleGroup メソッドは、以下の引数を受け入れます。
- groupName(文字列)グローバル ルール グループ名を指定します。
- agentType(PolicyMgtAgentType)エージェントのタイプを指定します。
- domain(PolicyMgtDomian)ルール グループを適用するためのドメインを指定します。
戻り値
CreateGlobalRuleGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup(オブジェクト)
- コールに失敗した場合は、undef
CreateHostConfig メソッド - ホスト設定オブジェクトを作成
CreateHostConfig メソッドは、ホスト設定オブジェクトを作成します。
構文
CreateHostConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateHostConfig(hostConfigName[, hostConfDesc][, enableFailover][, maxSocketsPerPort][, minSocketsPerPort][, newSocketstep][, requestTimeout])
Arguments
CreateHostConfig メソッドは、以下の引数を受け入れます。
- hostConfigName(文字列)ホスト設定オブジェクトの名前を指定します。
- hostConfDesc(文字列)(オプション)ホスト設定オブジェクトの説明を指定します。
- EnableFailover(int)(オプション)以下のように、ポリシー サーバとエージェント間に、フェールオーバまたはラウンド ロビン通信を使用するかどうかを指定します。
- 値 = 1フェールオーバ通信を指定します。
- 値 = 0ラウンド ロビン通信を指定します。
- maxSocketsPerPort(int)(オプション)エージェントとポリシー サーバ間で開くことができる TCP/IP ソケットの最大数を指定します。
- minSocketsPerPort(int)(オプション)エージェントとポリシー サーバ間で開くことができる TCP/IP ソケットの最小数を指定します。
- newSocketStep(int)(オプション)追加のソケットが必要なときに開くソケットの数を指定します。
- requestTimeout(int)(オプション)エージェントがポリシー サーバからのレスポンスを待機できる時間の長さを秒単位で指定します。
戻り値
CreateHostConfig メソッドは以下のいずれかの値を返します。
- PolicyMgtHostConfig(オブジェクト)
- コールに失敗した場合またはホスト設定名がすでに存在する場合は、undef
CreateODBCQueryScheme メソッド - ODBC クエリ方式を作成
CreateODBCQueryScheme メソッドは、ODBC クエリ方式を作成および設定します。ODBC クエリ方式は SQL クエリ方式とも呼ばれます。
注
: ODBC クエリ方式ごとに一意のデータ ソースを作成します。構文
CreateODBCQueryScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateODBCQueryScheme(schemeName[, schemeDesc][, queryEnumerate][, queryGetObjInfo][, queryLookup][, queryInitUser][, queryAuthenticateUser][, queryGetUserProp][, querySetUserProp][, queryGetUserProps][, queryLookupUser][, queryGetGroups][, queryIsGroupMember][, queryGetGroupProp][, querySetGroupProp][, queryGetGroupProps][, queryLookupGroup][, querySetPassword])
Arguments
CreateODBCQueryScheme メソッドは、以下の引数を受け入れます。
- schemeName(文字列)ODBC クエリ方式の名前を指定します。
- schemeDesc(文字列)(オプション)ODBC クエリ方式の説明を指定します。
- queryEnumerate(文字列)(オプション)ディレクトリ内のユーザ オブジェクトの名前をリストするクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryEnumerate を参照してください。
- queryGetObjInfo(文字列)(オプション)オブジェクトのクラスをフェッチするクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryGetObjInfo を参照してください。
- queryLookup(文字列)(オプション)グループ テーブル内の属性の値に基づいてオブジェクトを返すクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryLookup を参照してください。
- queryInitUser(文字列)(オプション)データベースに特定の名前のユーザが存在するかどうかを判定するクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryInitUser を参照してください。
- queryAuthenticateUser(文字列)(オプション)ユーザのパスワードを取得するクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryAuthenticateUser を参照してください。
- queryGetUserProp(文字列)(オプション)ユーザ プロパティの値を取得するクエリを定義します。注: プロパティはqueryGetUserPropsパラメータ文字列でリストされる必要があります。詳細については、メソッド PolicyMgtODBCQueryScheme>QueryGetUserProp を参照してください。
- querySetUserProp(文字列)(オプション)ユーザ プロパティの値を設定するクエリを定義します。注: プロパティはqueryGetUserPropsパラメータ文字列でリストされる必要があります。詳細については、メソッド PolicyMgtODBCQueryScheme>QuerySetUserProp を参照してください。
- queryGetUserProps(文字列)(オプション)ユーザ名と同じテーブルに存在するユーザ属性のカンマ区切りリストを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryGetUserProps を参照してください。
- queryLookupUser(文字列)(オプション)ユーザ テーブルの属性を通じて、ユーザ名を取得するクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryLookupUser を参照してください。
- queryGetGroups(文字列)(オプション)ユーザが属すグループの名前を取得するクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryGetGroups を参照してください。
- queryIsGroupMember(文字列)(オプション)特定のユーザがグループのメンバかどうかを判定するクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryIsGroupMember を参照してください。
- queryGetGroupProp(文字列)(オプション)グループ プロパティの値を返すクエリを定義します。注: プロパティはqueryGetGroupPropsパラメータ文字列でリストされる必要があります。詳細については、メソッド PolicyMgtODBCQueryScheme>QueryGetGroupProp を参照してください。
- querySetGroupProp(文字列)(オプション)グループ プロパティの値を設定するクエリを定義します。注: プロパティはqueryGetGroupPropsパラメータ文字列でリストされる必要があります。詳細については、メソッド PolicyMgtODBCQueryScheme>QuerySetGroupProp を参照してください。
- queryGetGroupProps(文字列)(オプション)グループ属性のカンマ区切りリストを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryGetGroupProps を参照してください。
- queryLookupGroup(文字列)(オプション)グループ テーブルの属性を通じて、グループ名を取得するクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QueryLookupGroup を参照してください。
- querySetPassword(文字列)(オプション)ユーザのパスワードを変更するクエリを指定します。注:詳細については、メソッド PolicyMgtODBCQueryScheme>QuerySetPassword を参照してください。
戻り値
CreateODBCQueryScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtODBCQueryScheme(オブジェクト)
- コールに失敗した場合またはODBC クエリ方式名がすでに存在する場合は、undef
CreatePwdPolicy メソッド - パスワード ポリシーを作成
CreatePwdPolicy メソッドは、パスワード ポリシーを作成および設定します。
構文
CreatePwdPolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreatePwdPolicy(pwdPolName, userDir[, pwdPolDesc][, enabledFlag][, entireDirFlag][, path][, class][, allowNestedGroups][, maxLoginFailures][, maxLoginInactive][, expDelay][, expWarningDays][, dicName][, dicMatchLength][, userwait][, pwdSvcRedirect][maxPwdLength][, minPwdLength][, maxPwdRepeatChar][, minPwdAlphaNum][, minPwdAlpha][, minPwdNonAlpha][, minPwdNonPrint][, minPwdNum][, minPwdPunc][, pwdReuseCount][, pwdReuseDelay][, pwdPctDiff][, pwdIgnoreSeq][, profileAttrMatch])
Arguments
CreatePwdPolicy メソッドは、以下の引数を受け入れます。
- pwdPolName(文字列)パスワード ポリシーの名前を指定します。
- userDir(PolicyMgtUserDir オブジェクト)パスワード ポリシーが適用されるユーザ ディレクトリを指定します。
- pwdPolDesc(文字列)(オプション)パスワード ポリシーの説明を指定します。
- enabledFlag(int)(オプション)パスワード ポリシーを有効にするかどうかを指定します。
- entireDirFlag(int)(オプション)LDAP ディレクトリ全体またはその一部のみにパスワード ポリシーを適用するかどうかを指定します。
- 値 = 1パスワード ポリシーが LDAP ディレクトリ全体に適用されることを指定します。
- 値 = 0パスワード ポリシーが LDAP ディレクトリの一部のみに適用されることを指定します。
注: LDAP ディレクトリの一部の場合は、pathパラメータでディレクトリ パスを指定し、classパラメータでクラスを指定します。 - path(文字列)(オプション)パスワード ポリシーが適用されるディレクトリの一部を指定します。注:entireDirFlagパラメータが 0 に設定されるときに、このパラメータを含めます。
- class(文字列)(オプション)パスワード ポリシーが適用されるクラスを指定します。注:entireDirFlagパラメータが 0 に設定されるときに、このパラメータを含めます。
- allowNestedGroups(int)(オプション)パスワード ポリシーが、LDAP ディレクトリ内のネストされたグループに関連付けられるかを指定します。注:entireDirFlagパラメータが 0 に設定されるときに、このパラメータを含めます。
- maxLoginFailures(int)(オプション)ユーザのアカウントが無効になるまでに許可される最大ログイン失敗数を指定します。
- maxLoginInactive(int)(オプション)ユーザのパスワードが期限切れになる前に許可される非アクティブ状態の最大日数を設定
- expDelay(int)(オプション)期限切れになるまでにパスワードを未変更にできる日数を指定します。
- expWarningDays(int)(オプション)パスワードが期限切れになることをユーザに事前に通知する場合の日数を設定します。
- dicName(文字列)(オプション)パスワードに使用できない語をリスト表示するディクショナリ ファイルの場所を指定します。
- dicMatchLength(int)(オプション)ディクショナリ確認に必要な文字の最小数を指定します。
- userwait(int)(オプション)アカウントが有効になりユーザが再度ログイン試行を許可されるまでにアカウントが無効になる時間数(分)を指定します。
- pwdSvcRedirect(文字列)(オプション)無効なパスワードが入力されたときにユーザがリダイレクトされる場合の URL を指定します。注: これはパスワード サービス CGI の URL である必要があります。
- maxPwdLength(int)(オプション)ユーザ パスワードの最大長を指定します。注: この値はパラメータminPwdLengthによって指定された値よりも大きくする必要があります。
- minPwdLength(int)(オプション)ユーザ パスワードの最小長を指定します。
- maxPwdRepeatChar(int)(オプション)パスワード内で連続して使用可能な同一文字の最大数を指定します。
- minPwdAlphaNum(int)(オプション)パスワードに使用する必要がある英数字(A ~ Z、a ~ z、0 ~ 9)の最小数を指定します。
- minPwdAlpha(int)(オプション)パスワードに使用する必要があるアルファベット文字(A ~ Z、a ~ z)の最小数を指定します。
- minPwdNonAlpha(int)(オプション)パスワードに使用する必要がある英数字以外の文字最小数を指定します。注:次の例は英数字以外の文字の例です。「@」、「$」および「*」。
- minPwdNonPrint(int)(オプション)パスワードに使用する必要がある印刷不能文字の最小数を指定します。注: 印刷不能文字はコンピュータ画面に表示されません。
- minPwdNum(int)(オプション)パスワードに使用する必要がある数字(0 ~ 9)の最小数を指定します。
- minPwdPunc(int)(オプション)パスワードに使用する必要がある句読点の最小数を指定します。注: 句読点にはピリオド、カンマ、感嘆符、スラッシュ、ハイフン、ダッシュが含まれます。
- pwdReuseCount(int)(オプション)古いパスワードを再利用するまでに使用する必要がある新しいパスワードの数を指定します。
- pwdReuseDelay(int)(オプション)パスワードを再利用する前にユーザが待機する必要がある日数を指定します。
- pwdPctDiff(int)(オプション)以前のパスワード内の文字と異なる必要がある新しいパスワード内の文字のパーセンテージを指定します。注: 値 100 は、新しいパスワードには古いパスワード内の文字を使用できないことを指定します。詳細は、パラメータpwdIgnoreSeqを参照してください。
- pwdIgnoreSeq(int)(オプション)新しいパスワードが古いパスワードと比較され、異なる文字のパーセンテージが計算されるときに、文字位置が無視されるかどうかを指定します。
- 値 = 1文字シーケンスが無視されることを指定します。
- 値 = 0文字シーケンスが考慮されることを指定します。例:文字「c」が新しいパスワードと古いパスワードの両方にあるが、各パスワード内のその位置が異なる場合、パーセンテージが計算されるときに、2 つの別の文字と見なされます。
- profileAttrMatch(int)(オプション)CA Single Sign-onがユーザのディレクトリ エントリ内の属性とパスワードを照合するときの最小文字シーケンスを指定します。
戻り値
CreatePwdPolicy メソッドは以下のいずれかの値を返します。
- PolicyMgtPwdPolicy(オブジェクト)
- コールに失敗した場合またはパスワード ポリシー名がすでに存在する場合は、undef
CreateRegScheme メソッド - 登録方式を作成
CreateRegScheme メソッドは、登録方式を作成および設定します。
構文
CreateRegScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateRegScheme(regName, userDir[, regDesc][, welcomeURL][, templatePath][, enableLogging])
Arguments
CreateRegScheme メソッドは、以下の引数を受け入れます。
- regName(文字列)登録方式の名前を指定します。
- userDir(文字列)登録方式に関連付けられたユーザ ディレクトリを指定します。
- regDesc(文字列)(オプション)登録方式の説明を指定します。
- welcomeURL(文字列)(オプション)ようこそページの URL を指定します。注: ユーザは正しく登録した後にこのページにリダイレクトされます。
- templatePath(文字列)(オプション)登録テンプレートがあるパスを指定します。注:templePathパラメータの詳細については、「注釈」を参照してください。
- enableLogging(int)(オプション)ログ記録を有効にするかどうかを指定します。
- 値 = 1ログ記録の有効化を指定します。
- 値 = 0(デフォルト)ログ記録の無効化を指定します。
戻り値
CreateRegScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtRegScheme(オブジェクト)
- コールに失敗した場合または登録方式名がすでに存在する場合は、undef
注釈
CA Single Sign-on
Web エージェントをインストールすると、デフォルトでは Web エージェント インストール ディレクトリのサブディレクトリ samples/selfreg に登録テンプレートがインストールされます。CA Single Sign-on
のインストール時に、仮想ディレクトリ /siteminderagent が作成され、Web エージェント インストール ディレクトリ内のサンプル ディレクトリが示されます。したがって、デフォルト ディレクトリを使用するときは、次のように templePath
を指定します。/siteminderagent/selfreg(最後のスラッシュなし)。登録用の SSL を使用している場合は、登録テンプレート用の絶対パスを指定する必要があります。デフォルト パスは以下のとおりです。
- Windows プラットフォーム: install-dir\Netegrity\Siteminder Web Agent\Samples\SelfReg\
- Solaris/Hpux プラットフォーム: install-dir/netegrity/siteminder/webagent/samples/selfreg/
CreateSAMLAffiliation メソッド - SAML 2.0 アフィリエーション オブジェクトを作成
CreateSAMLAffiliation メソッドは、SAML 2.0 アフィリエーション オブジェクトを作成します。SAML 2.0 アフィリエーションは、プリンシパル用の一意の名前 ID の単一のフェデレートされたネームスペースを共有する一連のエンティティです。既存の SAML アフィリエーションのプロパティを変更するには、メソッド PolicyMgtSAMLAffiliation->Property をコールします。
構文
CreateSAMLAffiliation メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateSAMLAffiliation(propsHash_ref)
Arguments
CreateSAMLAffiliation メソッドは以下のパラメータを受け入れます。
- propsHash_ref(ハッシュ)SAML 2.0 アフィリエーションのメタデータ プロパティのハッシュテーブルの参照を指定します。例: \%myhash
戻り値
CreateSAMLAffiliation メソッドは以下のいずれかの値を返します。
- PolicyMgtSAMLAffiliation(オブジェクト)
- コールに失敗した場合は、undef
注釈
SAML 2.0 アフィリエーション プロパティは、以下のようにグループ化されます。
- General PropertiesSAML_NAMESAML_DESCRIPTIONSAML_KEY_AFFILIATION_IDSAML_MAJOR_VERSIONSAML_MINOR_VERSIONSAML_OID
- 名前 ID プロパティSAML_SP_NAMEID_FORMATSAML_SP_NAMEID_TYPESAML_SP_NAMEID_STATICSAML_SP_NAMEID_ATTRNAMESAML_SP_NAMEID_DNSPEC
- ユーザ プロパティSAML_IDP_XPATHSAML_IDP_LDAP_SEARCH_SPECSAML_IDP_ODBC_SEARCH_SPECSAML_IDP_WINNT_SEARCH_SPECSAML_IDP_CUSTOM_SEARCH_SPECSAML_IDP_AD_SEARCH_SPEC
CreateSAMLAuthScheme メソッド - SAML 2.0 認証方式オブジェクトを作成
CreateSAMLAuthScheme メソッドは、SAML 2.0 認証方式オブジェクトをそのプロパティが指定された値に設定された状態で作成します。オブジェクトと関連付けられた次の 2 つのタイプのプロパティがあります。認証方式プロパティおよびメタデータ プロパティ。
認証方式プロパティ
認証方式プロパティは、SAML 2.0 テンプレートに基づき、以下の初期値があります。
- ライブラリデフォルト: smauthsaml
- Is_Templateデフォルト: FALSE
- Is_Used_by_Administratorデフォルト: FALSE
- Save_Credentialsデフォルト: FALSE
- Is_RADIUSデフォルト: FALSE
- Ignore_Password_Checkデフォルト: TRUE
- Protection_Levelデフォルト: 5
注
: デフォルト保護レベルを変更するには、CreateSAMLAuthScheme メソッドをコールし、オプションの protLevel
パラメータを新しい値に設定した状態にします。メタデータ プロパティ
メタデータ プロパティは、SAML 2.0 認証方式と関連付けられたアイデンティティ プロバイダのプロパティで、認証方式と共に保存されます。それらを指定するには、メタデータ プロパティのハッシュテーブルへの参照を
propsHash_ref
パラメータ内の CreateSAMLAuthScheme メソッドに渡します。既存の SAML 2.0 認証方式を更新するには、メソッド PolicyMgtSession->SAMLAuthSchemeProperties をコールします。構文
CreateSAMLAuthScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateSAMLAuthScheme(schemeName, propsHash_ref[, schemeDesc][, protLevel])
Arguments
CreateSAMLAuthScheme メソッドは、以下の引数を受け入れます。
- schemeName(文字列)認証方式の名前を指定します。
- propsHash_ref(ハッシュ)SAML 2.0 認証方式に関連付けられたメタデータ プロパティのハッシュテーブルの参照を指定します。例: \%myhash注: メタデータ プロパティの全リストについては、「注釈」を参照してください。
- schemeDesc(文字列)(オプション)認証方式の説明を指定します。
- protLevel(int)(オプション)認証方式の保護レベルを指定します。
戻り値
CreateSAMLAuthScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtAuthScheme(オブジェクト)
- コールに失敗した場合またはSAML 認証方式名がすでに存在する場合は、undef
注釈
SAML 2.0 認証方式と関連付けられたメタデータ プロパティを以下に示します。
- General PropertiesSAML_NAMESAML_DESCRIPTION
- 方式セットアップ プロパティSAML_IDP_SPIDSAML_KEY_IDPIDSAML_MAJOR_VERSIONSAML_MINOR_VERSIONSAML_SKEWTIMESAML_DISABLE_SIGNATURE_PROCESSINGSAML_DSIG_VERINFO_ISSUER_DNSAML_DSIG_VERINFO_SERIAL_NUMBER
- ユーザ プロパティSAML_IDP_XPATHSAML_IDP_LDAP_SEARCH_SPECSAML_IDP_ODBC_SEARCH_SPECSAML_IDP_WINNT_SEARCH_SPECSAML_IDP_CUSTOM_SEARCH_SPECSAML_IDP_AD_SEARCH_SPECSAML_AFFILIATION
- SSO プロパティSAML_IDP_SSO_REDIRECT_MODESAML_IDP_SSO_DEFAULT_SERVICESAML_AUDIENCESAML_IDP_SSO_TARGETSAML_ENABLE_SSO_ARTIFACT_BINDINGSAML_KEY_IDP_SOURCEIDSAML_IDP_ARTIFACT_RESOLUTION_DEFAULT_SERVICESAML_IDP_BACKCHANNEL_AUTH_TYPESAML_IDP_SPNAMESAML_IDP_PASSWORDSAML_ENABLE_SSO_POST_BINDINGSAML_IDP_SSO_ENFORCE_SINGLE_USE_POLICYSAML_SSOECPPROFILESAML_IDP_SIGN_AUTHNREQUESTS
- SLO プロパティSAML_SLO_REDIRECT_BINDINGSAML_SLO_SERVICE_VALIDITY_DURATIONSAML_SLO_SERVICE_URLSAML_SLO_SERVICE_RESPONSE_URLSAML_SLO_SERVICE_CONFIRM_URL
- 暗号化プロパティSAML_IDP_REQUIRE_ENCRYPTED_ASSERTIONSAML_IDP_REQUIRE_ENCRYPTED_NAMEID
- 属性プロパティSAML_IDP_SAMLREQ_ENABLESAML_IDP_SAMLREQ_REQUIRE_SIGNED_ASSERTIONSAML_IDP_SAMLREQ_ATTRIBUTE_SERVICESAML_IDP_SAMLREQ_GET_ALL_ATTRIBUTES
- 名前 ID プロパティSAML_IDP_SAMLREQ_NAMEID_FORMATSAML_IDP_SAMLREQ_NAMEID_TYPESAML_IDP_SAMLREQ_NAMEID_STATICSAML_IDP_SAMLREQ_NAMEID_ATTR_NAMESAML_IDP_SAMLREQ_NAMEID_DN_SPECSAML_IDP_SAMLREQ_NAMEID_ALLOW_NESTED
- 詳細プロパティSAML_SP_PLUGIN_CLASSSAML_SP_PLUGIN_PARAMSSAML_IDP_REDIRECT_URL_USER_NOT_FOUNDSAML_IDP_REDIRECT_MODE_USER_NOT_FOUNDSAML_IDP_REDIRECT_URL_FAILURESAML_IDP_REDIRECT_MODE_FAILURESAML_IDP_REDIRECT_URL_INVALIDSAML_IDP_REDIRECT_MODE_INVALID
CreateSingleCertMap メソッド - 単一属性の証明書マップを作成
CreateSingleCertMap メソッドは、証明書の Subject DN 内の単一属性と、ユーザ ディレクトリ内の対応するユーザ属性間の証明書マップを作成します。認証を成功させるには、Subject DN 内の属性の値と、ユーザ ディレクトリ内の対応するユーザ属性の値が一致する必要があります。
構文
CreateSingleCertMap メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateSingleCertMap(IssuerDN, Attribute[, DirectoryType])
Arguments
CreateSingleCertMap メソッドは、以下の引数を受け入れます。
- IssuerDN(文字列)証明書発行者の識別名を指定します。
- Attribute(文字列)証明書の Subject DN とユーザ ディレクトリ内でその値が一致する必要がある属性の名前を指定します。構文: %{attribute_name}例: %{uid}
- DirectoryType(int)(オプション)以下のように、認証用に指定されるユーザ ディレクトリのタイプを指定します。
- Sm_PolicyApi_DirType_LDAP(デフォルト)
- Sm_PolicyApi_DirType_WinNT
- Sm_PolicyApi_DirType_ODBC
戻り値
CreateSingleCertMap メソッドは以下のいずれかの値を返します。
- PolicyMgtCertMap(オブジェクト)
- コールに失敗した場合は、undef
注釈
証明書マップが作成されると、以下のフラグがデフォルト値である false に設定されます。
- certificate_required_flag
- use_distributionpoints_flag
- verify_signature_flag
- check_certificate_revocation_list_flag
- cache_certificate_revocation_list_entries_flag
これらのフラグの値の変更の詳細については、メソッド PolicyMgtSession>CreateExactCertMap を参照してください。
CreateTrustedHost メソッド - トラステッド ホスト オブジェクトを作成
CreateSAMLAuthScheme メソッドは、ポリシー ストアでトラステッド ホスト オブジェクトを作成し、ポリシー サーバにトラステッド ホストを登録します。さらに、登録が成功すると、ローカル登録ファイルを作成します。ポリシー サーバがエージェント ホストに接続されるときに、このメソッドを使用します。ポリシー サーバとエージェント ホスト間に接続がないときは、代わりにメソッド PolicyMgtSession->AddTrustedHost をコールします。
構文
CreateTrustedHost メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateTrustedHost(trustedHostName [,ipAddress][, adminName][, adminPassword][, hostConfigName][, registrationDataFileName])
Arguments
CreateTrustedHost メソッドは、以下の引数を受け入れます。
- trustedHostName(文字列)トラステッド ホストの名前を指定します。
- ipAddress(文字列)(オプション)ポリシー サーバの IP アドレスを指定します。
- adminName(文字列)(オプション)ポリシー サーバ管理者の名前を指定します。
- adminPassword(文字列)(オプション)管理者のパスワードを指定します。
- hostConfigName(文字列)(オプション)ホスト設定オブジェクトの名前を指定します。
- registrationDataFileName(文字列)(オプション)ホストがポリシー サーバに正しく登録されると、登録データが書き込まれるファイルの名前を指定します。注: このファイル名はエージェント API メソッドの Connect をコールすることによって指定されます。ファイルはCA Single Sign-onによって保存され管理されます。
戻り値
CreateTrustedHost メソッドは以下のいずれかの値を返します。
- PolicyMgtTrustedHost(オブジェクト)
- コールが失敗した場合またはトラステッド ホスト名がすでに存在する場合は、undef
CreateUserDir メソッド - ユーザ ディレクトリ オブジェクトを作成
CreateUserDir メソッドは、ユーザ ディレクトリ オブジェクトを作成および設定します。
構文
CreateUserDir メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateUserDir(dirName, namespace, server[, ODBCQueryScheme][, domDesc][, searchRoot][, usrLookStart][, usrLookEnd][, username][, password][, searchResults][, searchScope][, searchTimeout][, secureConn][, requireCreds][, disabledAttr][, UIDAttr][, anonID][, pwdData][, pwdAttr][, emailAttr][, chalRespAttr])
Arguments
CreateUserDir メソッドは、以下の引数を受け入れます。
- dirName(文字列)ユーザ ディレクトリ オブジェクトの名前を指定します。
- namespace(文字列)以下のように、ユーザ ディレクトリのネームスペースを指定します。
- LDAP
- AD
- ODBC
- Windows NT
- カスタム
- server(文字列)以下のいずれかのディレクトリ従属値を指定します。
- LDAP と ADLDAP サーバの IP アドレスおよびポート番号を指定します。構文: IP_address:port_number注: デフォルト ポート番号は 389 です。
- ODBCデータ ソース名を指定します。
- Windows NTドメイン名を指定します。
- カスタムカスタム ディレクトリに対応するライブラリの名前を指定します。
- ODBCQueryScheme(PolicyMgtODBCQueryScheme オブジェクト)(オプション) ODBC ディレクトリのクエリを実行するためにCA Single Sign-onが使用する一連のクエリを指定します。注:ユーザ ディレクトリが ODBC ディレクトリでない場合、このパラメータの値は undef です。
- domDesc(文字列)(オプション)ユーザ ディレクトリの説明を指定します。
- searchRoot(文字列)(オプション)以下のいずれかのディレクトリ従属値を指定します。
- LDAPディレクトリ接続の開始ポイントである LDAP ツリー内の場所を指定します。たとえば、組織(o)または組織単位(ou)などです。検索ルートと呼ばれるこの場所は、ポリシー サーバがユーザに対して検索を開始するポイントです。注: このパラメータの詳細については、パラメータsearchScopeを参照してください。
- カスタムカスタム ライブラリに渡す引数文字列を指定します。
- usrLookStart(文字列)(オプション)LDAP ディレクトリ内のユーザ DN 検索用の開始値を指定します。
- usrLookEnd(文字列)(オプション)LDAP ディレクトリ内のユーザ DN 検索用の終了値を指定します。
注
: ユーザ DN 検索開始ポイントおよびエンドポイントの値を指定すると、認証時に DN 文字列の一部を入力できます。以下の例で、ユーザはログインするときに DN 文字列全体ではなく、文字列「JSmith」のみを指定する必要があります。- DN = "uid=JSmith,ou=marketing,o=myorg.org"
- starting_point = "uid="
- endpoint = ",ou=marketing,o=myorg.org"
- login = "JSmith"
- username(文字列)(オプション)ユーザ ディレクトリにアクセスするために必要なユーザ名を指定します。注: このパラメータを使用するときは、requireCredsを 1 に設定します。
- password(文字列)(オプション)ユーザ ディレクトリにアクセスするために必要なパスワードを指定します。注: このパラメータを使用するときは、requireCredsを 1 に設定します。
- searchResults(int)(オプション)LDAP またはカスタム ディレクトリの検索から返される結果の最大数を指定します。
- searchScope(int)(オプション) LDAP ディレクトリ内のユーザまたはユーザ グループを検索する場合のCA Single Sign-on検索のレベル数を指定します。
- USERDIR_SCOPE_SUBTREEルートおよびその下のすべてのレベルの検索を指定します。
- USERDIR_SCOPE_ONELEVELルートおよびその 1 つ下のレベルの検索を指定します。
注: 詳細については、searchRootパラメータを参照してください。 - searchTimeout(int)(オプション)LDAP またはカスタム ディレクトリの検索に許容できる最大時間を秒単位で指定します。
- secureConn(int)(オプション)以下のように、LDAP またはカスタム ユーザ ディレクトリ接続が SSL によってセキュア保護されるかどうかを指定します。
- 値 = 1SSL によってセキュア保護される接続を指定します。
- 値 = 0(デフォルト)セキュア保護されない接続を指定します。
注:このフラグが有効な場合、CA Single Sign-on認証はセキュアであり、転送は暗号化されます。SSL を使用するときにこのフラグを有効にします。 - requireCreds(int)(オプション)以下のように、ユーザ認証情報が認証に必要かどうかを指定します。
- 値 = 1認証情報が必要であることを指定します。
- 値 = 0(デフォルト)認証情報が必要でないことを指定します。
- disabledAttr(文字列)(オプション)ユーザの無効化状態が含まれているユーザ ディレクトリ属性の名前を指定します。注: このパラメータは、LDAP ディレクトリ、ODBC ディレクトリおよびいくつかのカスタム ディレクトリに適用されます。
- UIDAttr(文字列)(オプション)ユーザ ディレクトリのユニバーサル ID 属性の名前を指定します。注:ユニバーサル ID は、ユーザのログイン ID とは異なり、ユーザ情報を検索するために使用されます。このパラメータは、LDAP ディレクトリ、ODBC ディレクトリ、WinNT ディレクトリおよびいくつかのカスタム ディレクトリに適用されます。
- anonID(文字列)(オプション)ユーザ ディレクトリの匿名ユーザ DN 属性の名前を指定します。注: 匿名の認証方式で定義される DN は、匿名の認証方式によって保護されたリソースへの匿名ユーザ アクセス権を与えます。このパラメータは、LDAP ディレクトリおよびいくつかのカスタム ディレクトリに適用されます。
- pwdData(文字列)(オプション)ユーザ ディレクトリのパスワード データ属性の名前を指定します。注: このパラメータは、LDAP ディレクトリ、ODBC ディレクトリおよびいくつかのカスタム ディレクトリに適用されます。
- pwdAttr(文字列)(オプション)ユーザ ディレクトリのパスワード属性の名前を指定します。注: このパラメータは、LDAP ディレクトリ、ODBC ディレクトリおよびいくつかのカスタム ディレクトリに適用されます。
- emailAttr(文字列)注: このオプションのパラメータは将来の使用のために予約されています。
- chalRespAttr(文字列)(オプション)ユーザ ディレクトリのチャレンジ/レスポンス属性の名前を指定します。例:チャレンジ/レスポンスは、ユーザがパスワードを忘れた場合にCA Single Sign-onがユーザに送信するヒントになる可能性があります。注: このパラメータは、LDAP ディレクトリおよびいくつかのカスタム ディレクトリに適用されます。
戻り値
CreateUserDir メソッドは以下のいずれかの値を返します。
- PolicyMgtUserDir(オブジェクト)
- コールに失敗した場合は、undef
CreateWSFEDAuthScheme メソッド - WS-Federation 認証方式を作成
CreateWSFEDAuthScheme メソッドは、WS-Federation 認証方式のインスタンスを作成し、認証方式のプロパティを設定します。
構文
CreateWSFEDAuthScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->CreateWSFEDAuthScheme(name, propsHash[, desc][, level])
Arguments
CreateWSFEDAuthScheme メソッドは、以下の引数を受け入れます。
- name(文字列)WS-Federation 認証方式の名前を指定します。
- propsHash(ハッシュ テーブル)設定する WS-Federation 認証方式プロパティのハッシュテーブルの参照を指定します。注: WS-Federation 認証方式プロパティの全リストについては、「注釈」を参照してください。
- desc(文字列)(オプション)認証方式の説明を指定します。
- level(int)(オプション)認証方式レベルを指定します。
戻り値
CreateWSFEDAuthScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtAuthScheme(オブジェクト)
- コールに失敗した場合は、undef
注釈
WS-Federation 認証方式プロパティは、管理 UI で以下のようにグループ化されます。
- [一般]タブWSFED_NAMEWSFED_DESCRIPTION
- [方式のセットアップ]タブ
- [WS-Federation の設定]-[一般]-[一般]タブWSFED_KEY_APIDWSFED_RPIDWSFED_SKEW_TIMEWSFED_DSIG_VERINFO_ALIASWSFED_DISABLE_SIGNATURE_PROCESSING
- [WS-Federation の設定]-[SAML プロファイル]-[Users Disambiguation]タブWSFED_AP_XPATHWSFED_AP_LDAP_SEARCH_SPECWSFED_AP_ODBC_SEARCH_SPECWSFED_AP_WINNT_SEARCH_SPECWSFED_AP_CUSTOM_SEARCH_SPECWSFED_AP_ADD_SEARCH_SPEC
- [WS-Federation の設定]-[SAML プロファイル]-[SSO]タブWSFED_AP_SSO_REDIRECT_MODEWSFED_AP_SSO_DEFAULT_SERVICEWSFED_AP_SSO_TARGETWSFED_ENFORCE_SINGLE_USE_POLICY
- [WS-Federation の設定]-[SAML プロファイル]-[サインアウト]タブWSFED_AP_SLO_ENABLEDWSFED_AP_SIGNOUT_URL
- [WS-Federation の設定]-[一般]-[詳細]タブWSFED_AP_PLUGIN_CLASSWSFED_AP_PLUGIN_PARAMSWSFED_AP_USER_NOT_FOUND_REDIRECT_URLWSFED_AP_USER_NOT_FOUND_REDIRECT_MODEWSFED_AP_FAILURE_REDIRECT_URLWSFED_AP_FAILURE_REDIRECT_MODEWSFED_AP_INVALID_REDIRECT_URLWSFED_AP_INVALID_REDIRECT_MODE
DeleteAdmin メソッド - 管理者を削除
DeleteAdmin メソッドは、ポリシー ストアから管理者を削除します。
構文
DeleteAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteAdmin(admin)
Arguments
DeleteAdmin メソッドは以下のパラメータを受け入れます。
- admin(PolicyMgtAdmin オブジェクト)削除する管理者オブジェクトを指定します。
戻り値
DeleteAdmin メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたは管理者が見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
注釈
特定のドメインから管理者を削除するには、メソッド PolicyMgtAffDomain>RemoveAdmin を参照してください。
DeleteAffDomain メソッド - アフィリエイト ドメインを削除
DeleteAffDomain メソッドは、アフィリエイト ドメインを削除します。
構文
DeleteAffDomain メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteAffDomain(affDomain)
Arguments
DeleteAffDomain メソッドは以下のパラメータを受け入れます。
- affDomain(PolicyMgtAffDomain オブジェクト)削除するアフィリエイト ドメイン オブジェクトを指定します。
戻り値
DeleteAffDomain メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはアフィリエイト ドメインが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteAgent メソッド - エージェントを削除
DeleteAgent メソッドは、エージェントを削除します。
構文
DeleteAgent メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteAgent(agent)
Arguments
DeleteAgent メソッドは以下のパラメータを受け入れます。
- agent(PolicyMgtAgent オブジェクト)削除するエージェント オブジェクトを指定します。
戻り値
DeleteAgent メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはエージェントが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteAgentConfig メソッド - エージェント設定オブジェクトを削除
DeleteAgentConfig メソッドは、エージェント設定オブジェクトを削除します。
構文
DeleteAgentConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteAgentConfig(AgentConfig)
Arguments
DeleteAgentConfig メソッドは以下のパラメータを受け入れます。
- AgentConfig(PolicyMgtAgentConfig オブジェクト)削除するエージェント設定オブジェクトを指定します。
戻り値
DeleteAgentConfig メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはエージェント設定オブジェクトが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteAuthAzMap メソッド - 認証および許可マップを削除
DeleteAuthAzMap メソッドは、認証および許可マップを削除します。
構文
DeleteAuthAzMap メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteAuthAzMap(map)
Arguments
DeleteAuthAzMap メソッドは以下のパラメータを受け入れます。
- map(PolicyMgtAuthAzMap オブジェクト)削除する認証および許可マップ オブジェクトを指定します。
戻り値
DeleteAuthAzMap メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたは認証および許可マップ オブジェクトが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteAuthScheme メソッド - 認証方式を削除
DeleteAuthScheme メソッドは、認証方式を削除します。
構文
DeleteAuthScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteAuthScheme(authScheme)
Arguments
DeleteAuthScheme メソッドは以下のパラメータを受け入れます。
- authScheme(PolicyMgtAuthScheme オブジェクト)削除する認証方式オブジェクトを指定します。
戻り値
DeleteAuthScheme メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたは認証方式が見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteCertMap メソッド - 証明書マップを削除
DeleteCertMap メソッドは、証明書マップを削除します。
構文
DeleteCertMap メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteCertMap(map)
Arguments
DeleteCertMap メソッドは以下のパラメータを受け入れます。
- map(PolicyMgtCertMap オブジェクト)削除する証明書マップ オブジェクトを指定します。
戻り値
DeleteCertMap メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたは証明書マップが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteDomain メソッド - ポリシー ドメインを削除
DeleteDomain メソッドは、ポリシー ドメインを削除します。
構文
DeleteDomain メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteDomain(domain)
Arguments
DeleteDomain メソッドは以下のパラメータを受け入れます。
- domain(PolicyMgtDomain オブジェクト)削除するドメイン オブジェクトを指定します。
戻り値
DeleteDomain メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはドメインが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteGlobalPolicy メソッド - グローバル ポリシーを削除
DeleteGlobalPolicy メソッドは、グローバル ポリシーを削除します。
構文
DeleteGlobalPolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteGlobalPolicy(policy)
Arguments
DeleteGlobalPolicy メソッドは以下のパラメータを受け入れます。
- policy(PolicyMgtPolicy オブジェクト)削除するグローバル ポリシー オブジェクトを指定します。
戻り値
DeleteGlobalPolicy メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteGlobalResponse メソッド - グローバル レスポンスを削除
DeleteGlobalResponse メソッドは、グローバル レスポンスを削除します。
構文
DeleteGlobalResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteGlobalResponse(response)
Arguments
DeleteGlobalResponse メソッドは以下のパラメータを受け入れます。
- response(PolicyMgtResponse オブジェクト)削除するグローバル レスポンス オブジェクトを指定します。
戻り値
DeleteGlobalResponse メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteGlobalRule メソッド - グローバル ルールを削除
DeleteGlobalRule メソッドは、グローバル ルールを削除します。
構文
DeleteGlobalRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteGlobalRule(rule)
Arguments
DeleteGlobalRule メソッドは以下のパラメータを受け入れます。
- rule(PolicyMgtRule オブジェクト)削除するグローバル ルール オブジェクトを指定します。
戻り値
DeleteGlobalRule メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteGroup メソッド - エージェント グループを削除
DeleteGroup メソッドは、エージェント グループを削除します。
構文
DeleteGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteGroup(group)
Arguments
DeleteGroup メソッドは以下のパラメータを受け入れます。
- group(PolicyMgtGroup オブジェクト)削除するエージェント グループ オブジェクトを指定します。
戻り値
DeleteGroup メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはエージェント グループが見つからないことを指定します。
- undefメソッドが失敗したことを指定します。
DeleteHostConfig メソッド - ホスト設定オブジェクトを削除
DeleteHostConfig メソッドは、ホスト設定オブジェクトを削除します。
構文
DeleteHostConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteHostConfig(HostConfig)
Arguments
DeleteHostConfig メソッドは以下のパラメータを受け入れます。
- HostConfig(PolicyMgtHostConfig オブジェクト)削除するホスト設定オブジェクトを指定します。
戻り値
DeleteHostConfig メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはホスト設定オブジェクトが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteODBCQueryScheme メソッド - ODBC クエリ方式を削除
DeleteODBCQueryScheme メソッドは、ODBC クエリ方式を削除します。
構文
DeleteODBCQueryScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteODBCQueryScheme(scheme)
Arguments
DeleteODBCQueryScheme メソッドは以下のパラメータを受け入れます。
- scheme(PolicyMgtODBCQueryScheme オブジェクト)削除する ODBC クエリ方式オブジェクトを指定します。
戻り値
DeleteODBCQueryScheme メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはODBC クエリ方式が見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeletePwdPolicy メソッド - パスワード ポリシーを削除
DeletePwdPolicy メソッドは、パスワード ポリシーを削除します。
構文
DeletePwdPolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeletePwdPolicy(pwdPolicy)
Arguments
DeletePwdPolicy メソッドは以下のパラメータを受け入れます。
- pwdPolicy(PolicyMgtPwdPolicy オブジェクト)削除するパスワード ポリシー オブジェクトを指定します。
戻り値
DeletePwdPolicy メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはパスワード ポリシーが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteRegScheme メソッド - 登録方式を削除
DeleteRegScheme メソッドは、登録方式を削除します。
構文
DeleteRegScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteRegScheme(regScheme)
Arguments
DeleteRegScheme メソッドは以下のパラメータを受け入れます。
- regScheme(PolicyMgtRegScheme オブジェクト)削除する登録方式オブジェクトを指定します。
戻り値
DeleteRegScheme メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたは登録方式が見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteSAMLAffiliation メソッド - SAML アフィリエーションを削除
DeleteSAMLAffiliation メソッドは、SAML 2.0 アフィリエーション オブジェクトを削除します。
構文
DeleteSAMLAffiliation メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteSAMLAffiliation(SAMLAffil)
Arguments
DeleteSAMLAffiliation メソッドは以下のパラメータを受け入れます。
- SAMLAffil(PolicyMgtSAMLAffiliation オブジェクト)削除する SAML 2.0 アフィリエーション オブジェクトを指定します。
戻り値
DeleteSAMLAffiliation メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたは SAML アフィリエーション オブジェクトが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteTrustedHost メソッド - トラステッド ホストを削除
DeleteTrustedHost メソッドは、トラステッド ホストを削除します。
構文
DeleteTrustedHost メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteTrustedHost(TrustedHost)
Arguments
DeleteTrustedHost メソッドは以下のパラメータを受け入れます。
- TrustedHost(PolicyMgtTrustedHost オブジェクト)削除するトラステッド ホスト オブジェクトを指定します。
戻り値
DeleteTrustedHost メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはトラステッド ホストが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
DeleteUserDir メソッド - ユーザ ディレクトリを削除
DeleteUserDir メソッド
構文
DeleteUserDir メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->DeleteUserDir(userdir)
Arguments
DeleteUserDir メソッドは以下のパラメータを受け入れます。
- userDir(PolicyMgtUserDir オブジェクト)削除するユーザ ディレクトリ オブジェクトを指定します。
戻り値
DeleteUserDir メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことまたはユーザ ディレクトリが見つからないことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
GetAdmin メソッド - 管理者を取得
GetAdmin メソッドは、指定された管理者を取得します。
構文
GetAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAdmin(adminName)
Arguments
GetAdmin メソッドは以下のパラメータを受け入れます。
- adminName(文字列)取得する管理者の名前を指定します。
戻り値
GetAdmin メソッドは以下のいずれかの値を返します。
- コールに成功する場合は、PolicyMgtAdmin オブジェクト
- コールに失敗した場合または指定された管理者が存在しない場合は、undef
GetAffDomain メソッド - アフィリエイト ドメインを取得
GetAffDomain メソッドは、指定されたアフィリエイト ドメインを取得します。
構文
GetAffDomain メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAffDomain(domName)
Arguments
GetAffDomain メソッドは以下のパラメータを受け入れます。
- domName(文字列)取得するアフィリエイト ドメインの名前を指定します。
戻り値
GetAffDomain メソッドは以下のいずれかの値を返します。
- PolicyMgtAffDomain オブジェクト
- コールに失敗した場合または指定されたアフィリエイト ドメインが存在しない場合は、undef
GetAgent メソッド - エージェントを取得
GetAgent メソッドは、指定されたエージェントを取得します。
構文
GetAgent メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAgent(agentName)
Arguments
GetAgent メソッドは以下のパラメータを受け入れます。
- agentName(文字列)取得するエージェントの名前を指定します。
戻り値
GetAgent メソッドは以下のいずれかの値を返します。
- コールに成功する場合は、PolicyMgtAgent オブジェクト
- コールに失敗した場合または指定されたエージェントが存在しない場合は、undef
GetAgentConfig メソッド - エージェント設定オブジェクトを取得
GetAgentConfig メソッドは、指定されたエージェント設定オブジェクトを取得します。
構文
GetAgentConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAgentConfig(acName)
Arguments
GetAgentConfig メソッドは以下のパラメータを受け入れます。
- acName(文字列)取得するエージェント設定オブジェクトの名前を指定します。
戻り値
GetAgentConfig メソッドは以下のいずれかの値を返します。
- コールに成功する場合は、PolicyMgtAgentConfig オブジェクト
- コールに失敗した場合または指定されたエージェント設定オブジェクトが存在しない場合は、undef
GetAgentGroup メソッド - エージェント グループを取得
GetAgentGroup メソッドは、指定されたエージェント グループを取得します。
構文
GetAgentGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAgentGroup(agentGroup)
Arguments
GetAgentGroup メソッドは以下のパラメータを受け入れます。
- agentGroup(文字列)取得するエージェント グループの名前を指定します。
戻り値
GetAgentGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup オブジェクト
- コールに失敗した場合または指定されたエージェント グループが存在しない場合は、undef
GetAgentType メソッド - エージェント タイプを取得
GetAgentType メソッドは、指定されたエージェント タイプを取得します。
構文
GetAgentType メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAgentType(agentTypeName)
Arguments
GetAgentType メソッドは以下のパラメータを受け入れます。
- agentTypeName(文字列)取得する以下のいずれかの事前定義済みエージェント タイプを指定します。
- 3Com(RADIUS エージェント)
- アフィリエイト エージェント(CA Single Sign-onアフィリエイト エージェント)
- AffiliateMinder(AffiliateMinder エージェント)
- Ascend(RADIUS エージェント)
- Bay Networks(RADIUS エージェント)
- CheckPoint(RADIUS エージェント)
- Cisco(RADIUS エージェント)
- EJB エージェント(CA Single Sign-onEJB エージェント)
- Generic RADIUS(RADIUS エージェント)
- Livingston(RADIUS エージェント)
- Network Associates Sniffer(RADIUS エージェント)
- Servlet エージェント(CA Single Sign-onServlet エージェント)
- Shiva(RADIUS エージェント)
- TeleBit(RADIUS エージェント)
- U.S. Robotics(RADIUS エージェント)
- Web エージェント(CA Single Sign-onWeb エージェント)
戻り値
GetAgentType メソッドは以下のいずれかの値を返します。
- コールに成功する場合は、PolicyMgtAgentType オブジェクト
- コールに失敗した場合または指定されたエージェント タイプが存在しない場合は、undef
GetAllAdmins メソッド - すべての管理者のリストを取得
GetAllAdmins メソッドは、ポリシー サーバ上で設定されているすべての管理者のリストを取得します。
構文
GetAllAdmins メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllAdmins() (returnCode)
Arguments
GetAllAdmins メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAdmins メソッドは以下のいずれかの値を返します。
- PolicyMgtAdmin(配列)
GetAllAffDomains メソッド - すべてのアフィリエイト ドメインのリストを取得
GetAllAffDomains メソッドは、設定されたすべてのアフィリエイト ドメインのリストを取得します。
構文
GetAllAffDomains メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllAffDomains() (returnCode)
Arguments
GetAllAffDomains メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAffDomains メソッドは以下のいずれかの値を返します。
- PolicyMgtAffDomain(配列)
GetAllAgentConfigs メソッド - すべてのエージェント設定オブジェクトのリストを取得
GetAllAgentConfigs メソッドは、すべてのエージェント設定オブジェクトのリストを取得します。
構文
GetAllAgentConfigs メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllAgentConfigs() (returnCode)
Arguments
GetAllAgentConfigs メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAgentConfigs メソッドは以下のいずれかの値を返します。
- PolicyMgtAgentConfig(配列)
GetAllAgentGroups メソッド - すべてのエージェント グループ オブジェクトのリストを取得
GetAllAgentGroups メソッドは、すべてのエージェント グループ オブジェクトのリストを取得します。
構文
GetAllAgentGroups メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllAgentGroups() (returnCode)
Arguments
GetAllAgentGroups メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAgentGroups メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup(配列)
GetAllAgents メソッド - すべてのエージェントのリストを取得
GetAllAgents メソッドは、ポリシー サーバ上で設定されているすべてのエージェントのリストを取得します。
構文
GetAllAgents メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllAgents() (returnCode)
Arguments
GetAllAgents メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAgents メソッドは以下のいずれかの値を返します。
- PolicyMgtAgent(配列)
GetAllAuthAzMaps メソッド - すべての AuthAz マップのリストを取得
GetAllAuthAzMaps メソッドは、すべての認証および許可マップのリストを取得します。
構文
GetAllAuthAzMaps メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllAuthAzMaps() (returnCode)
Arguments
GetAllAuthAzMaps メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAuthAzMaps メソッドは以下の値を返します。
- PolicyMgtAuthAzMap(配列)
GetAllAuthSchemes メソッド - 認証方式のリストを取得
GetAllAuthSchemes メソッドは、ポリシー サーバ上で設定されているすべての認証方式のリストを取得します。
構文
GetAllAuthSchemes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllAuthSchemes([showTemplates]) (returnCode)
Arguments
GetAllAuthSchemes メソッドは以下の引数を受け入れます。
- showTemplates(int)(オプション)認証方式のリストにテンプレート方式を含めるかどうかを指定します。
- 値 = 0認証方式のリストにテンプレート方式を含めないことを指定します。
- 値 = 1認証方式のリストにテンプレート方式を含めることを指定します。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAuthSchemes メソッドは以下のいずれかの値を返します。
- PolicyMgtAuthScheme(配列)
GetAllCertMaps メソッド - 証明書マッピング オブジェクトのリストを取得
GetAllCertMaps メソッドは、すべての証明書マッピング オブジェクトのリストを取得します。
構文
GetAllCertMaps メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllCertMaps() (returnCode)
Arguments
GetAllCertMaps メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllCertMaps メソッドは以下のいずれかの値を返します。
- PolicyMgtCertMap(配列)
GetAllDomains メソッド - すべてのドメインのリストを取得
GetAllDomains メソッドは、ポリシー サーバ上で設定されているすべてのドメインのリストを取得します。
構文
GetAllDomains メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllDomains() (returnCode)
Arguments
GetAllDomains メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllDomains メソッドは以下のいずれかの値を返します。
- PolicyMgtDomain(配列)
GetAllGlobalPolicies メソッド - グローバル ポリシー オブジェクトのリストを取得
GetAllGlobalPolicies メソッドは、すべてのグローバル ポリシー オブジェクトのリストを取得します。
構文
GetAllGlobalPolicies メソッドの形式は以下のとおりです。
Netegrity::GetAllGlobalPolicies() (returnCode)
Arguments
GetAllGlobalPolicies メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllGlobalPolicies メソッドは以下の値を返します。
- PolicyMgtPolicy(配列)
GetAllGlobalResponses メソッド - すべてのグローバル レスポンス オブジェクトのリストを取得
GetAllGlobalResponses メソッドは、すべてのグローバル レスポンス オブジェクトのリストを取得します。
構文
GetAllGlobalResponses メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllGlobalResponses() (returnCode)
Arguments
GetAllGlobalResponses メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllGlobalResponses メソッドは以下の値を返します。
- PolicyMgtResponse(配列)
GetAllGlobalRules メソッド - すべてのグローバル ルール オブジェクトのリストを取得
GetAllGlobalRules メソッドは、すべてのグローバル ルール オブジェクトのリストを取得します。
構文
GetAllGlobalRules メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllGlobalRules() (returnCode)
Arguments
GetAllGlobalRules メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllGlobalRules メソッドは以下の値を返します。
- PolicyMgtRule(配列)
GetAllHostConfigs メソッド - すべてのホスト設定オブジェクトのリストを取得
GetAllHostConfigs メソッドは、すべてのホスト設定オブジェクトのリストを取得します。
構文
GetAllHostConfigs メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllHostConfigs() (returnCode)
Arguments
GetAllHostConfigs メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllHostConfigs メソッドは以下の値を返します。
- PolicyMgtHostConfig(配列)
GetAllODBCQuerySchemes メソッド - すべての ODBC クエリ方式のリストを取得
GetAllODBCQuerySchemes メソッドは、ポリシー サーバ上のすべての ODBC クエリ方式のリストを取得します。
構文
GetAllODBCQuerySchemes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllODBCQuerySchemes() (returnCode)
Arguments
GetAllODBCQuerySchemes メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllODBCQuerySchemes メソッドは以下の値を返します。
- PolicyMgtODBCQueryScheme(配列)
GetAllPwdPolicies メソッド - すべてのパスワード ポリシーのリストを取得
GetAllPwdPolicies メソッドは、設定されたすべてのパスワード ポリシーのリストを取得します。
構文
GetAllPwdPolicies メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllPwdPolicies() (returnCode)
Arguments
GetAllPwdPolicies メソッドは、以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllPwdPolicies メソッドは以下の値を返します。
- PolicyMgtPwdPolicy(配列)
GetAllRegSchemes メソッド - すべての登録方式のリストを取得
GetAllRegSchemes メソッドは、ポリシー サーバ上で設定されているすべての登録方式のリストを取得します。
構文
GetAllRegSchemes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllRegSchemes() (returnCode)
Arguments
GetAllRegSchemes メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllRegSchemes メソッドは以下の値を返します。
- PolicyMgtRegScheme(配列)
GetAllSAMLAffiliations メソッド - すべての SAML 2.0 アフィリエーションのリストを取得
GetAllSAMLAffiliations メソッドは、すべての SAML 2.0 アフィリエーションのリストを取得します。
構文
GetAllSAMLAffiliations メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllSAMLAffiliations() (returnCode)
Arguments
GetAllSAMLAffiliations メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllSAMLAffiliations メソッドは以下の値を返します。
- PolicyMgtSAMLAffiliation(配列)
GetAllSAMLSchemeAttributes メソッド - すべてのリクエスタ属性のリストを取得
GetAllSAMLSchemeAttributes メソッドは、定義されたすべての SAML 2.0 リクエスタ属性のリストを取得します。
構文
GetAllSAMLSchemeAttributes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllSAMLSchemeAttributes(scheme) (returnCode)
Arguments
GetAllSAMLSchemeAttributes メソッドは以下の引数を受け入れます。
- scheme(PolicyMgtAuthScheme オブジェクト)SAML 2.0 認証方式オブジェクトを指定します。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllSAMLSchemeAttributes メソッドは以下の値を返します。
- PolicyMgtSAMLRequesterAttr(配列)
GetAllTrustedHosts メソッド - すべてのトラステッド ホスト オブジェクトのリストを取得
GetAllTrustedHosts メソッドは、すべてのトラステッド ホスト オブジェクトのリストを取得します。
構文
GetAllTrustedHosts メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllTrustedHosts() (returnCode)
Arguments
GetAllTrustedHosts メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllTrustedHosts メソッドは以下の値を返します。
- PolicyMgtTrustedHost(配列)
GetAllUserDirs メソッド - すべてのユーザ ディレクトリのリストを取得
GetAllUserDirs メソッドは、ポリシー サーバと関連付けられたすべてのユーザ ディレクトリのリストを取得します。
構文
GetAllUserDirs メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllUserDirs() (returnCode)
Arguments
GetAllUserDirs メソッドの以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllUserDirs メソッドは以下の値を返します。
- PolicyMgtUserDir(配列)
GetAllVariableTypes メソッド - すべての変数タイプ オブジェクトのリストを取得
GetAllVariableTypes メソッドは、ポリシー サーバ上で設定されているすべての変数タイプ オブジェクトのリストを取得します。
構文
GetAllVariableTypes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAllVariableTypes() (returnCode)
Arguments
GetAllVariableTypes メソッドは以下の引数を受け入れます。
- returnCode (int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllVariableTypes メソッドは以下の値を返します。
- PolicyMgtVariableType(配列)
GetAuthScheme メソッド - 認証方式オブジェクトを取得
GetAuthScheme メソッドは、指定された認証方式オブジェクトを取得します。既存の認証方式は名前によって指定されます。新しい認証方式を作成するには、このメソッドを使用して、新しい方式のベースにする認証方式オブジェクトまたはテンプレートのタイプを取得します。次に、結果として得られたオブジェクトを、PolicyMgtSession>CreateAuthScheme メソッドに
schemeTemplate
パラメータで渡します。SAML 2.0 認証方式の作成については、メソッド PolicyMgtSession>CreateSAMLAuthScheme を参照してください。構文
GetAuthScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetAuthScheme(schemeName)
Arguments
GetAuthScheme メソッドは以下のパラメータを受け入れます。
- schemeName(文字列)以下のいずれかを指定します。
- 既存の認証方式の名前を指定します。
- 作成する認証方式のタイプは以下のとおりです。
- 匿名テンプレート
- SSL を介した基本テンプレート
- 基本テンプレート
- カスタム テンプレート
- HTML フォーム テンプレート
- インパーソネーション テンプレート
- RADIUS CHAP/PAP テンプレート
- RADIUS サーバ テンプレート
- SafeWord HTML フォーム テンプレート
- SafeWord テンプレート
- SAML Artifact テンプレート
- SAML POST テンプレート
- SAML 2.0 テンプレート
- SecurID HTML フォーム テンプレート
- SecurID テンプレート
- TeleID テンプレート
- Windows 認証テンプレート
- X509 クライアント証明書および基本テンプレート
- X509 クライアント証明書およびフォーム テンプレート
- X509 クライアント証明書または基本テンプレート
- X509 クライアント証明書またはフォーム テンプレート
- X509 クライアント証明書テンプレート
戻り値
GetAuthScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtAuthScheme(オブジェクト)
- コールに失敗した場合または指定された認証方式が存在しない場合は、undef
GetCertMap メソッド - 証明書マッピング オブジェクトを取得
GetCertMap メソッドは、証明書発行者の DN によって指定された証明書マッピング オブジェクトを取得します。
構文
GetCertMap メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetCertMap(issuerDN)
Arguments
GetCertMap メソッドは以下のパラメータを受け入れます。
- issuerDN(文字列)証明書発行者の DN を指定します。
戻り値
GetCertMap メソッドは以下のいずれかの値を返します。
- PolicyMgtCertMap(オブジェクト)
- コールに失敗した場合または指定された発行者の DN が存在しない場合は、undef
GetDomain メソッド - ドメイン オブジェクトを取得
GetDomain メソッドは、指定されたポリシー ドメイン オブジェクトを取得します。
構文
GetDomain メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetDomain(domName)
Arguments
GetDomain メソッドは以下のパラメータを受け入れます。
- domName(文字列)取得するドメインの名前を指定します。
戻り値
GetDomain メソッドは以下のいずれかの値を返します。
- PolicyMgtDomain(オブジェクト)
- コールに失敗した場合または指定されたドメインが存在しない場合は、undef
GetGlobalPolicy メソッド - グローバル ポリシー オブジェクトを取得
GetGlobalPolicy メソッドは、指定されたグローバル ポリシー オブジェクトを取得します。
構文
GetGlobalPolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetGlobalPolicy(policyName)
Arguments
GetGlobalPolicy メソッドは以下のパラメータを受け入れます。
- policyName(文字列)取得するグローバル ポリシーの名前を指定します。
戻り値
GetGlobalPolicy メソッドは以下のいずれかの値を返します。
- PolicyMgtPolicy(オブジェクト)
- コールに失敗した場合または指定されたグローバル ポリシーが存在しない場合は、undef
GetGlobalResponse メソッド - グローバル レスポンス オブジェクトを取得
GetGlobalResponse メソッドは、指定されたグローバル レスポンス オブジェクトを取得します。
構文
GetGlobalResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetGlobalResponse(responseName)
Arguments
GetGlobalResponse メソッドは以下のパラメータを受け入れます。
- responseName(文字列)取得するグローバル レスポンスの名前を指定します。
戻り値
GetGlobalResponse メソッドは以下のいずれかの値を返します。
- PolicyMgtResponse(オブジェクト)
- コールに失敗した場合または指定されたグローバル レスポンスが存在しない場合は、undef
GetGlobalRule メソッド - グローバル ルール オブジェクトを取得
GetGlobalRule メソッドは、指定されたグローバル ルール オブジェクトを取得します。
構文
GetGlobalRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetGlobalRule(ruleName)
Arguments
GetGlobalRule メソッドは以下のパラメータを受け入れます。
- ruleName(文字列)取得するグローバル ルールの名前を指定します。
戻り値
GetGlobalRule メソッドは以下のいずれかの値を返します。
- PolicyMgtRule(オブジェクト)
- コールに失敗した場合または指定されたグローバル ルールが存在しない場合は、undef
GetHostConfig メソッド - ホスト設定オブジェクトを取得
GetHostConfig メソッドは、指定されたホスト設定オブジェクトを取得します。
構文
GetHostConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetHostConfig(hcName)
Arguments
GetHostConfig メソッドは以下のパラメータを受け入れます。
- hcName(文字列)取得するホスト設定オブジェクトの名前を指定します。
戻り値
GetHostConfig メソッドは以下のいずれかの値を返します。
- PolicyMgtHostConfig(オブジェクト)
- コールに失敗した場合または指定されたホスト設定オブジェクトが存在しない場合は、undef
GetODBCQueryScheme メソッド - ODBC クエリ方式オブジェクトを取得
GetODBCQueryScheme メソッドは、指定された ODBC クエリ方式オブジェクトを取得します。
構文
GetODBCQueryScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetODBCQueryScheme(schemeName)
Arguments
GetODBCQueryScheme メソッドは以下のパラメータを受け入れます。
- schemeName(文字列)取得する ODBC クエリ方式を指定します。
戻り値
GetODBCQueryScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtODBCQueryScheme(オブジェクト)
- コールに失敗した場合または指定された ODBC クエリ方式が存在しない場合は、undef
GetPwdPolicy メソッド - パスワード ポリシー オブジェクトを取得
GetPwdPolicy メソッドは、指定されたパスワード ポリシー オブジェクトを取得します。
構文
GetPwdPolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetPwdPolicy(pwdPolicyName)
Arguments
GetPwdPolicy メソッドは以下のパラメータを受け入れます。
- pwdPolicyName(文字列)取得するパスワード ポリシーの名前を指定します。
戻り値
GetPwdPolicy メソッドは以下のいずれかの値を返します。
- PolicyMgtPwdPolicy(オブジェクト)
- コールに失敗した場合または指定されたパスワード ポリシーが存在しない場合は、undef
GetRegScheme メソッド - 登録方式オブジェクトを取得
GetRegScheme メソッドは、指定された登録方式オブジェクトを取得します。
構文
GetRegScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetRegScheme(schemeName)
Arguments
GetRegScheme メソッドは以下のパラメータを受け入れます。
- schemeName(文字列)取得する登録方式の名前を指定します。
戻り値
GetRegScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtRegScheme(オブジェクト)
- コールに失敗した場合または指定された登録方式が存在しない場合は、undef
GetSAMLAffiliation メソッド - SAML 2.0 アフィリエーション オブジェクトを取得
GetSAMLAffiliation メソッドは、指定された SAML 2.0 アフィリエーション オブジェクトを取得します。
構文
GetSAMLAffiliation メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetSAMLAffiliation(affilName)
Arguments
GetSAMLAffiliation メソッドは以下のパラメータを受け入れます。
- affilName(文字列)取得する SAML アフィリエーションの名前または OID を指定します。注:OID を指定するときは、その前に「@」文字を付けることができます。
戻り値
GetSAMLAffiliation メソッドは以下のいずれかの値を返します。
- PolicyMgtSAMLAffiliation(オブジェクト)
- コールに失敗した場合または指定された SAML アフィリエーションが存在しない場合は、undef
GetSAMLAffiliationById メソッド - ID により SAML 2.0 アフィリエーション オブジェクトを取得
GetSAMLAffiliationById メソッドは、メソッドに渡されるアフィリエーション ID によって指定された SAML 2.0 アフィリエーション オブジェクトを取得します。
構文
GetSAMLAffiliationById メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetSAMLAffiliationById(affilID)
Arguments
GetSAMLAffiliationById メソッドは以下のパラメータを受け入れます。
- affilID(文字列)取得する SAML アフィリエーションのアフィリエーション ID を指定します。
戻り値
GetSAMLAffiliationById メソッドは以下のいずれかの値を返します。
- PolicyMgtSAMLAffiliation(オブジェクト)
- コールに失敗した場合または指定された SAML アフィリエーションが存在しない場合は、undef。
GetSharedSecretPolicy メソッドは、指定された共有秘密キー ロールオーバー ポリシー オブジェクトを取得します。それぞれのポリシー ストア ドメインには、1 つの共有秘密キー ロールオーバー ポリシーのみが存在できるので、ポリシーの名前をこのメソッドに渡す必要はありません。
構文
GetSharedSecretPolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetSharedSecretPolicy()
Arguments
GetSharedSecretPolicy メソッドは、引数を受け入れません。
戻り値
GetSharedSecretPolicy メソッドは、以下の値を返します。
- PolicyMgtSharedSecretPolicy(オブジェクト)
GetTrustedHost メソッド - トラステッド ホスト オブジェクトを取得
GetTrustedHost メソッドは、指定されたトラステッド ホスト オブジェクトを取得します。
構文
GetTrustedHost メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetTrustedHost(thName)
Arguments
GetTrustedHost メソッドは以下のパラメータを受け入れます。
- thName(文字列)取得するトラステッド ホストの名前を指定します。
戻り値
GetTrustedHost メソッドは以下のいずれかの値を返します。
- PolicyMgtTrustedHost(オブジェクト)
- コールに失敗した場合または指定されたトラステッド ホストが存在しない場合は、undef
GetUserDir メソッド - ユーザ ディレクトリ オブジェクトを取得
GetUserDir メソッドは、指定されたユーザ ディレクトリ オブジェクトを取得します。
構文
GetUserDir メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetUserDir(dirName)
Arguments
GetUserDir メソッドは以下のパラメータを受け入れます。
- dirName(文字列)取得するユーザ ディレクトリの名前を指定します。
戻り値
GetUserDir メソッドは以下のいずれかの値を返します。
- PolicyMgtUserDir(オブジェクト)
- コールに失敗した場合または指定されたユーザ ディレクトリが存在しない場合は、undef
GetVariableType メソッド - 変数タイプ オブジェクトを取得
GetVariableType メソッドは、指定された変数タイプ オブジェクトを取得します。指定されたタイプの新しい変数オブジェクトを作成するには、結果として得られる変数タイプ オブジェクトを CreateVariable メソッドに
varType
パラメータで渡します。構文
GetVariableType メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->GetVariableType(varTypeName)
Arguments
GetVariableType メソッドは以下のパラメータを受け入れます。
- varTypeName(文字列)以下のいずれかの変数タイプ名を指定します。
- CA Single Sign-on変数タイプPostUserContextRequestContextスタティックWebService
- TransactionMinder 変数タイプXMLBodyXMLAgentXMLEnvelopeHeader[Transport]SAMLAssertion
注: 変数タイプ名は大文字と小文字を区別し、スペースを含めることはできません。
戻り値
GetVariableType メソッドは以下のいずれかの値を返します。
- PolicyMgtVariableType (オブジェクト)
- コールに失敗した場合は、undef
注釈
コマンド ライン インターフェースでは、TransactionMinder 変数を作成できません。TransactionMinder と Option Pack がインストールされている場合は、管理 UI で TransactionMinder 変数を作成できます。
RemoveAttributeFromSAMLScheme メソッド - SAML 方式から属性を削除
RemoveAttributeFromSAMLScheme メソッドは、SAML 2.0 認証方式から属性を削除します。
構文
RemoveAttributeFromSAMLScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->RemoveAttributeFromSAMLScheme(scheme, pSAMLRequesterAttr)
Arguments
RemoveAttributeFromSAMLScheme メソッドは、以下の引数を受け入れます。
- scheme(PolicyMgtAuthScheme オブジェクト)属性を削除する SAML 2.0 認証方式を指定します。
- pSAMLRequesterAttribute(文字列)削除する属性を指定します。
戻り値
RemoveAttributeFromSAMLScheme メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
SAMLAuthSchemeProperties メソッド - SAML メタデータ プロパティを設定または取得
SAMLAuthSchemeProperties メソッドは、既存の SAML 2.0 認証方式に存在する SAML 2.0 メタデータ プロパティを設定または取得します。SAML 2.0 メタデータ プロパティの完全なリストについては、メソッド PolicyMgtSession>CreateSAMLAuthScheme を参照してください。
構文
SAMLAuthSchemeProperties メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->SAMLAuthSchemeProperties(scheme, propsHash_ref)
Arguments
SAMLAuthSchemeProperties メソッドは、以下の引数を受け入れます。
- scheme(PolicyMgtAuthScheme オブジェクト)そのメタデータ プロパティを設定または取得する認証方式を指定します。
- propsHash_ref(ハッシュ)設定または取得するメタデータ プロパティのハッシュテーブルの参照を指定します。
戻り値
SAMLAuthSchemeProperties メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
注釈
ハッシュテーブルが空のとき、SAMLAuthSchemeProperties メソッドはすべてのメタデータ プロパティを取得します。以下のように空のハッシュテーブルを定義できます。
%myhash=();
次に、以下のように空のハッシュテーブルを参照できます。
\%myhash
最後に、ハッシュテーブルの参照を SAMLAuthSchemeProperties メソッドに
propsHash_ref
パラメータを通じて渡します。WSFEDAuthSchemeProperties メソッド - WS-Federation プロパティを設定または取得
WSFEDAuthSchemeProperties メソッドは、既存の WS-Federation 認証方式内で WS-Federation メタデータ プロパティを設定または取得します。WS-Federation メタデータ プロパティの全リストについては、メソッド PolicyMgtSession>CreateWSFEDAuthScheme を参照してください。
構文
WSFEDAuthSchemeProperties メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSession->WSFEDAuthSchemeProperties(scheme, propsHash_ref)
Arguments
WSFEDAuthSchemeProperties メソッドは、以下の引数を受け入れます。
- scheme(PolicyMgtAuthScheme オブジェクト)その WS-Federation メタデータ プロパティが設定または取得される認証方式を指定します。
- propsHash_ref(ハッシュ)設定または取得するメタデータ プロパティのハッシュテーブルの参照を指定します。
戻り値
WSFEDAuthSchemeProperties メソッドは以下のいずれかの値を返します。
- 値 = 0メソッドが成功したことを指定します。
- 値 = -1メソッドが失敗したことを指定します。
注釈
ハッシュテーブルが空のとき、WSFEDAuthSchemeProperties メソッドはすべてのメタデータ プロパティを取得します。以下のように空のハッシュテーブルを定義できます。
%myhash=();
次に、以下のように空のハッシュテーブルを参照できます。
\%myhash
最後に、ハッシュテーブルの参照を WSFEDAuthSchemeProperties メソッドに
propsHash_ref
パラメータを通じて渡します。