CLI ドメイン メソッド
ここでは、CLI ドメイン メソッドについて説明します。
casso127jpjp
ここでは、CLI ドメイン メソッドについて説明します。
AddAdmin メソッド - ドメインに管理者を追加
AddAdmin メソッドは、ドメインに管理者を追加します。
構文
AddAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->AddAdmin(admin)
[Parameters]
AddAdmin メソッドは以下のパラメータを受け入れます。
- admin(タイプ)ドメインに追加する管理者を指定します。
戻り値
AddAdmin メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は、-1
注釈
管理者は、ドメイン内の
CA Single Sign-on
オブジェクトを作成、編集、削除できます。特定のドメインの管理者を作成するためにポリシー管理 API を使用することはできません。ただし、管理 UI を使用してドメインの管理者を作成する場合は、PolicyMgtAffDomain->AddAdmin メソッドをコールして、別のドメインにその管理者を追加できます。
AddUserDir メソッド - ドメインとユーザ ディレクトリを関連付け
AddUserDir メソッドは、ドメインとユーザ ディレクトリを関連付けます。
構文
AddUserDir メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->AddUserDir(userDir)
[Parameters]
AddUserDir メソッドは以下のパラメータを受け入れます。
- userDir(PolicyMgtUserDir)ドメインと関連付けるユーザ ディレクトリを指定します。
戻り値
AddUserDir メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は、-1
注釈
ユーザ認証時に、ユーザが提供した認証情報は、このユーザ ディレクトリに保存された認証情報と照合されます。
ディレクトリ オブジェクトが検索順序の最後に追加されます。検索順序を変更するには、PolicyMgtAffDomain->SetUserDirSearchOrder メソッドをコールします。
CreatePolicy メソッド - ドメイン内のポリシーを作成および設定
CreatePolicy メソッドは、ドメイン内のポリシーを作成および設定します。
構文
CreatePolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->CreatePolicy(policyName [, policyDesc] [, enableFlag] [, activeExpr])
[Parameters]
CreatePolicy メソッドは、以下のパラメータを受け入れます。
- policyName(文字列)ポリシーの名前を指定します。
- policyDesc(文字列)(オプション)ポリシーの説明を指定します。
- enableFlag(int)(オプション)以下のようにポリシーを有効(1)にするか無効(0)にするかを指定します。デフォルトは有効化です。
- activeExpr(文字列)(オプション)ポリシーのアクティブな式を指定します。
戻り値
CreatePolicy メソッドは以下のいずれかの値を返します。
- PolicyMgtPolicy オブジェクト
- コールに失敗した場合は、undef
CreateRealm メソッド - ドメイン内にトップレベル レルムを作成および設定
CreateRealm メソッドは、ドメイン内にトップレベル レルムを作成および設定します。
構文
CreateRealm メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->CreateRealm(realmName, agent, authScheme [, realmDesc] [, resFilter] [, procAuthEvents] [, procAzEvents] [, protectAll] [, maxTimeout] [, idleTimeout] [, syncAudit] [, azUserDir] [, regScheme])
[Parameters]
CreateRealm メソッドは、以下のパラメータを受け入れます。
- realmName(文字列)レルムの名前を指定します。
- agent(PolicyMgtAgent)レルムを保護するエージェントまたはエージェントのグループを指定します。
- authScheme(PolicyMgtAuthScheme)レルムと関連付ける認証方式を指定します。
- realmDesc(文字列)(オプション)レルムの説明を指定します。
- resFilter(文字列)(オプション)レルムのリソース フィルタを指定します。
- procAuthEvents(int)(オプション)認証イベントを処理するかどうかを指定します。有効にするには 1 に設定し、無効にするには 0 に設定します。デフォルトは有効化です。認証イベント処理はパフォーマンスに影響します。レルムのルールを認証イベントによってトリガしない場合は、このフラグを 0 に設定します。
- procAzEvents(int)(オプション)許可イベントを処理するかどうかを指定します。有効にするには 1 に設定し、無効にするには 0 に設定します。デフォルトは有効化です。認可イベント処理はパフォーマンスに影響します。レルムのルールを許可イベントによってトリガしない場合は、このフラグを 0 に設定します。
- protectAll(int)(オプション)デフォルトのリソース保護をアクティブにするかどうかを指定します。有効にするには 1 に設定し、無効にするには 0 に設定します。デフォルトは有効化です。
- maxTimeout(int)(オプション)再認証が必要になる前に、ユーザがレルムにアクセスできる最大時間を秒単位で指定します。デフォルトは 7200 です(2 時間)。
- idleTimeout(int)(オプション)再認証が必要になる前に、ユーザがレルムで非アクティブ状態を維持できる最大時間を秒単位で指定します。デフォルトは 3600 です(1 時間)。
- syncAudit(int)(オプション)同期監査を有効にするフラグを指定します。有効にするには 1 に設定し、無効にするには 0 に設定します。このフラグが有効な場合は、リソースへのアクセスを許可する前に、CA Single Sign-onはポリシー サーバおよびエージェント アクションをログ記録します。デフォルトは無効化です。
- azUserDir(PolicyMgtUserDir)(オプション)レルム内のユーザが許可されるディレクトリを指定します。デフォルトはデフォルト ディレクトリです。
- regScheme(タイプ)(オプション)レルム内のリソースにアクセスする新しいユーザを登録するために使用される登録方式を指定します。
戻り値
CreateRealm メソッドは以下のいずれかの値を返します。
- PolicyMgtRealm オブジェクト
- コールに失敗した場合は、undef
注釈
このメソッドは、非永続セッション用に設定されるレルムを作成します。
CA Single Sign-on
5.0 の永続セッションに対してレルムを設定するには、管理 UI でレルムを編集します。注: ポリシー管理 API は、以下のようにそのメソッドがコールされたオブジェクトの直接の子孫であるレルムのみを操作します。
- ドメイン下のレルムの場合は、ドメイン オブジェクト内のトップレベルのレルムのみを操作できます。
- レルム下のレルムの場合は、特定のレベルの直下のレルムのみを操作できます。
CreateResponse メソッド - レスポンスを作成
CreateResponse メソッドは、レスポンスを作成します。
構文
CreateResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->CreateResponse(resName, agentType [, resDesc])
[Parameters]
CreateResponse メソッドは、以下のパラメータを受け入れます。
- resName(文字列)レスポンスの名前を指定します。
- agentType(PolicyMgtAgentType)レスポンスと関連付けられたエージェント タイプを指定します。エージェント タイプ オブジェクトを取得するには、PolicyMgtSession->GetAgentType メソッドをコールします。
- resDesc(文字列)(オプション)レスポンスの説明を指定します。
戻り値
CreateResponse メソッドは以下のいずれかの値を返します。
- PolicyMgtResponse オブジェクト
- コールに失敗した場合は、undef
注釈
エージェントは、ある特定のイベントに基づいてレスポンスを返します。たとえば、不正なユーザが保護されている Web ページにアクセスしようとすると、レスポンスによりユーザを適切なメッセージを表示する HTML ページにリダイレクトできます。
CreateResponseGroup メソッド - ドメインに対してレスポンス グループを作成
CreateResponseGroup メソッドは、ドメイン用のレスポンス グループを作成します。
構文
CreateResponseGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->CreateResponseGroup(groupName, agentType, [, groupDesc])
[Parameters]
CreateResponseGroup メソッドは、以下のパラメータを受け入れます。
- groupName(文字列)グループの名前を指定します。
- agentType(PolicyMgtAgentType)レスポンス グループと関連付けられたエージェント タイプを指定します。エージェント タイプ オブジェクトを取得するには、PolicyMgtSession->GetAgentType メソッドをコールします。
- groupDesc(文字列)(オプション)グループの説明を指定します。
戻り値
CreateResponseGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup オブジェクト
- コールに失敗した場合は、undef
CreateRuleGroup メソッド - ドメインに対してルール グループを作成
CreateRuleGroup メソッドは、ドメインのルール グループを作成します。
構文
CreateRuleGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->CreateRuleGroup(groupName, agentType [, groupDesc])
[Parameters]
CreateRuleGroup メソッドは、以下のパラメータを受け入れます。
- groupName(文字列)グループの名前を指定します。
- agentType(PolicyMgtAgentType)このルール グループと関連付けられたエージェント タイプを指定します。エージェント タイプ オブジェクトを取得するには、PolicyMgtSession->GetAgentType メソッドをコールします。
- groupDesc(文字列)(オプション)グループの説明を指定します。
戻り値
CreateRuleGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup オブジェクト
- コールに失敗した場合は、undef
DeleteGroup メソッド - ドメインからグループを削除
DeleteGroup メソッドは、ドメイン内の指定されたグループを削除します。
構文
DeleteGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyManagementDomain->DeleteGroup(group)
[Parameters]
DeleteGroup メソッドは以下のパラメータを受け入れます。
- group(PolicyMgrGroup)削除するグループを指定します。
戻り値
DeleteGroup メソッドは以下のいずれかの値を返します。
- 成功した場合またはグループが見つからなかった場合は 0
- コールに失敗した場合は -1
DeletePolicy メソッド - ポリシーを削除
DeletePolicy メソッドは、ポリシーを削除します。
構文
DeletePolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->DeletePolicy(policy)
[Parameters]
DeletePolicy メソッドは以下のパラメータを受け入れます。
- policy(PolicyMgtPolicy)削除するポリシーを指定します。
戻り値
DeletePolicy メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は -1
DeleteRealm メソッド - ドメイン内のレルムを削除
DeleteRealm メソッドは、ドメイン内のトップレベル レルムを削除します。
構文
DeleteRealm メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->DeleteRealm(realm)
[Parameters]
DeleteRealm メソッドは以下のパラメータを受け入れます。
- realm(PolicyMgtRealm)削除するレルムを指定します。
戻り値
DeleteRealm メソッドは以下のいずれかの値を返します。
- 成功した場合またはレルムが見つからなかった場合は 0
- コールに失敗した場合は -1
DeleteResponse メソッド - レスポンスを削除
DeleteResponse メソッドは、レスポンスを削除します。
構文
DeleteResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->DeleteResponse(response)
[Parameters]
DeleteResponse メソッドは以下のパラメータを受け入れます。
- response(PolicyMgtResponse)削除するレスポンスを指定します。
戻り値
DeleteResponse メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は -1
Description メソッド - ドメインの説明を設定または取得
Description メソッドは、ドメインの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->Description([domainDesc])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
- domainDesc(文字列)(オプション)設定する説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
- 新規または既存のドメインの説明
- 失敗の場合は、空の文字列
GetAllPolicies メソッド - ドメインと関連付けられたすべてのポリシーを取得
GetAllPolicies メソッドは、ドメインと関連付けられたすべてのポリシーを取得します。
構文
GetAllPolicies メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetAllPolicies( ) (returnCode)
[Parameters]
GetAllPolicies メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllPolicies メソッドは以下の値を返します。
- PolicyMgtPolicy オブジェクトの配列
GetAllRealms メソッド - ドメイン内のすべてのトップレベル レルムを取得
GetAllRealms メソッドは、ドメイン内のすべてのトップレベル レルムを取得します。
構文
GetAllRealms メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetAllRealms( ) (returnCode)
[Parameters]
GetAllRealms メソッド以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllRealms メソッドは以下の値を返します。
- PolicyMgtRealm オブジェクトの配列
注釈
レルム下でトップレベル レルムをすべて取得するには、PolicyMgtRealm->GetAllChildRealms メソッドをコールします。
GetAllResponseGroups メソッド - ドメインと関連付けられたすべてのレスポンス グループを取得
GetAllResponseGroups メソッドは、ドメインと関連付けられたすべてのレスポンス グループを取得します。
構文
GetAllResponseGroups メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetAllResponseGroups( ) (returnCode)
[Parameters]
GetAllResponseGroups メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllResponseGroups メソッドは以下の値を返します。
- PolicyMgtGroup オブジェクトの配列
GetAllResponses メソッド - ドメインと関連付けられたすべてのレスポンスを取得
GetAllResponses メソッドは、ドメインと関連付けられたすべてのレスポンスを取得します。
構文
GetAllResponses メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetAllResponses() (returnCode)
[Parameters]
GetAllResponses メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllResponses メソッドは以下の値を返します。
- PolicyMgtResponse オブジェクトの配列
GetAllRuleGroups メソッド - ドメインと関連付けられたすべてのルール グループを取得
GetAllRuleGroups メソッドは、ドメインと関連付けられたすべてのルール グループを取得します。
構文
GetAllRuleGroups メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetAllRuleGroups() (returnCode)
[Parameters]
GetAllRuleGroups メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllRuleGroups メソッドは以下の値を返します。
- PolicyMgtGroup オブジェクトの配列
GetPolicy メソッド - ドメインのポリシーを取得
GetPolicy メソッドは、ドメイン内のポリシーを取得します。
構文
GetPolicy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetPolicy(policyName)
[Parameters]
GetPolicy メソッドは以下のパラメータを受け入れます。
- policyName(文字列)取得するポリシーを指定します。
戻り値
GetPolicy メソッドは以下のいずれかの値を返します。
- PolicyMgtPolicy オブジェクト
- コールに失敗する場合または指定されたポリシーが存在しない場合は、undef
GetRealm メソッド - ドメイン内のトップレベル レルムを取得
GetRealm メソッドは、ドメイン内のトップレベル レルムを取得します。
構文
GetRealm メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetRealm(realmName)
[Parameters]
GetRealm メソッドは以下のパラメータを受け入れます。
- realmName(文字列)取得するレルムを指定します。
戻り値
GetRealm メソッドは以下のいずれかの値を返します。
- PolicyMgtRealm オブジェクト
- コールに失敗する場合または指定されたレルムが存在しない場合は、undef
GetResponse メソッド - ドメインと関連付けられたレスポンスを取得
GetResponse メソッドは、ドメインと関連付けられたレスポンスを取得します。
構文
GetResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetResponse(resName)
[Parameters]
GetResponse メソッドは以下のパラメータを受け入れます。
- resName(文字列)取得するレスポンスを指定します。
戻り値
GetResponse メソッドは以下のいずれかの値を返します。
- PolicyMgtResponse オブジェクト
- コールに失敗する場合または指定されたレスポンスが存在しない場合は、undef
GetResponseGroup メソッド - 指定されたレスポンス グループを取得
GetResponseGroup メソッドは、指定されたレスポンス グループを取得します。
構文
GetResponseGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetResponseGroup(groupName)
[Parameters]
GetResponseGroup メソッドは以下のパラメータを受け入れます。
- groupName(文字列)取得するレスポンス グループの名前を指定します。
戻り値
GetResponseGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup オブジェクト
- コールに失敗した場合は、undef
GetRuleGroup メソッド - 指定されたルール グループを取得
GetRuleGroup メソッドは、指定されたルール グループを取得します。
構文
GetRuleGroup メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetRuleGroup(groupName)
[Parameters]
GetRuleGroup メソッドは以下のパラメータを受け入れます。
- groupName(文字列)取得するグループの名前を指定します。
戻り値
GetRuleGroup メソッドは以下のいずれかの値を返します。
- PolicyMgtGroup オブジェクト
- コールに失敗した場合は、undef
GetUserDirSearchOrder メソッド - ドメインと関連付けられたユーザ ディレクトリ オブジェクトを取得
GetUserDirSearchOrder メソッドは、ドメインと関連付けられたユーザ ディレクトリ オブジェクトを取得します。
構文
GetUserDirSearchOrder メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GetUserDirSearchOrder( )
[Parameters]
GetUserDirSearchOrder メソッドは、パラメータを受け入れません。
戻り値
GetUserDirSearchOrder メソッドは以下のいずれかの値を返します。
- PolicyMgtUserDir オブジェクト
- コールに失敗した場合は、undef
注釈
返されるオブジェクトの順序は、ディレクトリのクエリ実行時に
CA Single Sign-on
が使用する順序と同じです。検索順序を変更するには、PolicyMgtAffDomain->SetUserDirSearchOrder メソッドをコールします。GlobalPoliciesApply メソッド - グローバル ポリシーに対してドメインが有効かどうかを判定
GlobalPoliciesApply メソッドは、グローバル ポリシーに対してドメインが有効かどうかを示すフラグを設定または取得します。ドメインがグローバル ポリシーに対して有効な場合、グローバルおよびドメイン固有のポリシーをドメインに適用できます。
構文
GlobalPoliciesApply メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->GlobalPoliciesApply([globalFlag])
[Parameters]
GlobalPoliciesApply メソッドは以下のパラメータを受け入れます。
- globalFlag(int)(オプション)グローバル ポリシーに対してドメインを有効にするかどうかを指定します。
- 1 は、グローバル ポリシーを有効にすることを指定します
- 0 は、グローバル ポリシーを無効にすることを指定します
戻り値
GlobalPoliciesApply メソッドは以下のいずれかの値を返します。
- 新規または既存のフラグ設定
Name メソッド - ドメイン名を設定または取得
Name メソッドは、ドメイン名を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->Name([domainName])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
- domainName(文字列)(オプション)ドメインに割り当てる名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
- 新規または既存のドメイン名
- コールに失敗した場合は、undef
RemoveAdmin メソッド - ドメインから管理者の関連付けを解除
RemoveAdmin メソッドは、ドメインから管理者の関連付けを解除します。
構文
RemoveAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->RemoveAdmin(admin)
[Parameters]
RemoveAdmin メソッドは以下のパラメータを受け入れます。
- admin(PolicyMgtAdmin)ドメインから削除する管理者を指定します。
戻り値
RemoveAdmin メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は、-1
注釈
ポリシー ストアから管理者を削除するには、PolicyMgtSession->DeleteAdmin メソッドも参照してください。
特定のドメインの管理者を作成するためにポリシー管理 API を使用することはできません。ただし、管理者が管理 UI または PolicyMgtAffDomain->AddAdmin メソッドのいずれかによってドメインと関連付けられる場合は、RemoveAdmin メソッドをコールして、ドメインからその管理者を削除できます。
RemoveUserDir メソッド - ドメインからユーザ ディレクトリの関連付けを解除
RemoveUserDir メソッドは、ドメインからユーザ ディレクトリの関連付けを解除します。
構文
RemoveUserDir メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->RemoveUserDir(userDir)
[Parameters]
RemoveUserDir メソッドは以下のパラメータを受け入れます。
- userDir(PolicyMgtUserDir)ドメインから関連付けを解除するユーザ ディレクトリを指定します。
戻り値
RemoveUserDir メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は、-1
SetUserDirSearchOrder メソッド - ユーザ ディレクトリ オブジェクトの検索順序を再調整
SetUserDirSearchOrder メソッドは、ドメインと関連付けられたユーザ ディレクトリ オブジェクトの検索順序を再調整します。
構文
SetUserDirSearchOrder メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtDomain->SetUserDirSearchOrder(dirArray)
[Parameters]
SetUserDirSearchOrder メソッドは以下のパラメータを受け入れます。
- dirArray()ユーザ ディレクトリ オブジェクトの配列の参照を指定します(たとえば、\@myarray)。
戻り値
SetUserDirSearchOrder メソッドは以下のいずれかの値を返します。
- PolicyMgtUserDir オブジェクトの配列
- コールに失敗した場合は、undef
メソッドは以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。