CLI レルム メソッド
ここでは、CLI レルム メソッドについて説明します。
casso1283
ここでは、CLI レルム メソッドについて説明します。
Agent メソッド - レルムのエージェントを設定または取得
Agent メソッドは、レルムのエージェントを設定または取得します。
構文
Agent メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->Agent([agent])
[Parameters]
Agent メソッドは、以下のパラメータを受け入れます。
- agent(PolicyMgtAgent)(オプション)レルムに設定するエージェントを指定します。
戻り値
Agent メソッドは以下のいずれかの値を返します。
- 新規または既存のレルム用の PolicyMgtAgent オブジェクト
- レルム用の新規または既存の PolicyMgtGroup オブジェクト
- コールに失敗した場合は、undef
AuthScheme メソッド - レルムの認証方式を設定または取得
AuthScheme メソッドは、レルムの認証方式を設定または取得します。
構文
AuthScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->AuthScheme([authScheme])
[Parameters]
AuthScheme メソッドは以下のパラメータを受け入れます。
- authScheme(PolicyMgtAuthScheme)(オプション)レルムに設定する認証方式を指定します。
戻り値
AuthScheme メソッドは以下のいずれかの値を返します。
- 新規または既存のレルム用の PolicyMgtAuthScheme オブジェクト
- コールに失敗した場合は、undef
AzUserDir メソッド - レルムの許可ユーザ ディレクトリを設定または取得
AzUserDir メソッドは、レルムの許可ユーザ ディレクトリを設定または取得します。
構文
AzUserDir メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->AzUserDir([dir])
[Parameters]
AzUserDir メソッドは以下のパラメータを受け入れます。
- dir(PolicyMgtUserDirectory)(オプション)レルムに設定する許可ユーザ ディレクトリを指定します。
戻り値
AzUserDir メソッドは以下のいずれかの値を返します。
- 新規または既存のレルム用の PolicyMgtUserDir オブジェクト
- 存在しない場合、またはコールに失敗した場合は、undef
CreateChildRealm メソッド - 子レルムを作成および設定
CreateChildRealm メソッドは、このメソッドのコール元レルム下のレルム ディレクトリを作成および設定します。
構文
CreateChildRealm メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->CreateChildRealm(realmName, agent, authScheme [, realmDesc] [, resFilter] [, procAuthEvents] [, procAzEvents] [, protectAll] [, maxTimeout] [, idleTimeout] [, syncAudit] [, azUserDir] [, regScheme])
[Parameters]
CreateChildRealm メソッドは、以下のパラメータを受け入れます。
- realmName(文字列)レルムの名前を指定します。
- agent(PolicyMgtAgent)レルムのエージェントまたはエージェントのグループを指定します。
- authScheme(PolicyMgtAuthScheme)レルムと関連付ける認証方式を指定します。
- realmDesc(文字列)(オプション)レルムの説明を指定します。
- resFilter(文字列)(オプション)レルムのリソース フィルタを指定します。
- procAuthEvents(int)(オプション)認証イベントを処理するためのフラグを指定します。有効にするには 1 に設定し、無効にするには 0 に設定します。デフォルトは有効化です。
- procAzEvents(int)(オプション)許可イベントを処理するためのフラグを指定します。有効にするには 1 に設定し、無効にするには 0 に設定します。デフォルトは有効化です。
- protectAll(int)(オプション)デフォルトのリソース保護をアクティブにするためのフラグを指定します。有効にするには 1 に設定し、無効にするには 0 に設定します。デフォルトは有効化です。
- maxTimeout(int)(オプション)再認証が必要になる前に、ユーザがレルムにアクセスできる最大時間を秒単位で指定します。デフォルトは 7200 です(2 時間)。
- idleTimeout(int)(オプション)再認証が必要になる前に、ユーザがレルムで非アクティブ状態を維持できる最大時間を指定します。デフォルトは 3600 です(1 時間)。
- syncAudit(int)(オプション)同期監査を有効にするフラグを指定します。有効にするには 1 に設定し、無効にするには 0 に設定します。このフラグが有効な場合は、リソースへのアクセスを許可する前に、SiteMinderはポリシー サーバおよびエージェント アクションをログ記録します。デフォルトは有効化です。
- azUserDir(PolicyMgtUserDir)(オプション)レルム内のユーザが許可されるディレクトリを指定します。デフォルトは、デフォルト ディレクトリです。
- regScheme(PolicyMgtRegScheme)(オプション)レルム内のリソースにアクセスする新しいユーザを登録するために使用される登録方式を指定します。
戻り値
CreateChildRealm メソッドは以下のいずれかの値を返します。
- PolicyMgtRealm オブジェクト
- コールに失敗した場合は、undef
注釈
このメソッドは、非永続セッション用に設定されるレルムを作成します。
SiteMinder
5.0 の永続セッションに対してレルムを設定するには、管理 UI でレルムを編集します。注: ポリシー管理 API は、以下のようにそのメソッドがコールされたオブジェクトの直接の子孫であるレルムのみを操作します。
- ドメイン下のレルムの場合。ドメイン オブジェクト内のトップレベルのレルムのみを操作できます。
- レルム下のレルムの場合。親レルムの直下のレルムのみを操作できます。
CreateRule メソッド- レルム下のルールを作成および設定
CreateRule メソッドは、レルム下のルールを作成および設定します。
構文
CreateRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->CreateRule( ruleName [, ruleDesc] [, action] [, resource] [, allowAccess] [, regexMatch] [, activeExpr] [, isEnabled] )
[Parameters]
CreateRule メソッドは、以下のパラメータを受け入れます。
- ruleName(文字列)ルールの名前を指定します
- ruleDesc(文字列)(オプション)ルールの説明を指定します。
- action(文字列)(オプション)ルールが実行されるアクションのタイプを指定します。以下のいずれかのアクション。アクション タイプが Web エージェント アクションの場合は、以下の 1 つ以上の HTTP アクションを使用します。複数のアクションを区切るには、カンマを使用します。
- GET。HTTP を使用して表示するためのリソースを取得します。
- POST。HTTP を使用してユーザ提供の情報を POST 送信します。
- PUT。レガシー HTTP アクションをサポートします。
アクション タイプが認証イベントの場合- OnAuthAccept。ユーザ認証が正常に行われたときに発生します。
- OnAuthAttempt。ユーザ名が入力されていないために、ユーザ認証が失敗したときに発生します。
- OnAuthChallenge。カスタム認証方式で使用し、レスポンスを発行することができます。
- OnAuthReject。ユーザが認証に失敗したときに発生します。
- OnAuthUserNotFound。アクティブ レスポンスをトリガするために使用します。
アクション タイプが許可イベントの場合- OnAccessAccept。SiteMinderで、リソースへのアクセスがユーザに対して正常に許可された場合に発生します。
- OnAccessReject。SiteMinderで、リソースへのアクセスが許可されなかったためにユーザを拒否する場合に発生します。
- resource(文字列)(オプション)ルールによって保護されるリソースを指定します。この値はアクション タイプ認証イベントには適用されません。
- allowAccess(int)(オプション)ルールによって保護されたリソースへのアクセスを許可または拒否するためのフラグを指定します。1 はアクセスを許可し、0 はアクセスを拒否します。このフラグは、タイプ GET、PUT または POST(またはその両方) のアクション値にのみ適用されます。デフォルトは 1 です。
- regexMatch(int)(オプション)resourceフィールドでの正規表現パターン一致を許可するためのフラグを指定します。1 は正規表現一致を許可します。0 は正規表現一致を拒否します。このフラグはアクション タイプ 認証イベントには適用されません。デフォルトは 0 です。
- activeExpr(文字列)(オプション)ルールに関連付けられるアクティブな式を指定します。
- isEnabled(int)(オプション)ルールを有効または無効にするフラグを指定します。有効にするには 1、無効にするには 0 を指定します。デフォルトは有効化です。
戻り値
CreateRule メソッドは以下のいずれかの値を返します。
- PolicyMgtRule オブジェクト
- コールに失敗した場合は、undef
DeleteChildRealm メソッド - レルム内のトップレベル レルムを削除
DeleteChildRealm メソッドは、レルム内のトップレベル レルムを削除します。
構文
DeleteChildRealm メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->DeleteChildRealm(realm)
[Parameters]
DeleteChildRealm メソッドは以下のパラメータを受け入れます。
- realm(PolicyMgtRealm)削除する子レルムを指定します。
戻り値
DeleteChildRealm メソッドは以下のいずれかの値を返します。
- 成功した場合またはレルムが見つからなかった場合は 0
- コールに失敗する場合は、-1
DeleteRule メソッド - レルム内の既存のルールを削除
DeleteRule メソッドは、レルム内の既存のルールを削除します。
構文
DeleteRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->DeleteRule(rule)
[Parameters]
DeleteRule メソッドは以下のパラメータを受け入れます。
- rule(PolicyMgtRule)削除するルールを指定します。
戻り値
DeleteRule メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールが失敗する場合、またはルールがルールを削除するために使用するレルムの一部でない場合は、-1
Description メソッド - レルムの説明を設定または取得
Description メソッドは、レルムの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->Description([realmDesc])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
- realmDesc(文字列)(オプション)レルムに割り当てる説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
- 新規または既存のレルムの説明
- コールに失敗した場合は、空の文字列
Flush メソッド - リソース キャッシュからレルムをフラッシュ
Flush メソッドは、リソース キャッシュからレルムをフラッシュします。
構文
Flush メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->Flush()
[Parameters]
Flush メソッドは、パラメータを受け入れません。
戻り値
Flush メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗する場合は、-1
GetAllChildRealms メソッド - レルム内のすべてのトップレベル レルムを取得
GetAllChildRealms メソッドは、レルム内のすべてのトップレベル レルムを取得します。子のみを返します。
構文
GetAllChildRealms メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->GetAllChildRealms() (returnCode)
[Parameters]
GetAllChildRealms メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllChildRealms メソッドは以下の値を返します。
- PolicyMgtRealm オブジェクトの配列
GetAllRules メソッド - レルムと関連付けられたルールを取得
GetAllRules メソッドは、レルムと関連付けられたルールを取得します。
構文
GetAllRules メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->GetAllRules() (returnCode)
[Parameters]
GetAllRules メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllRules メソッドは以下の値を返します。
- PolicyMgtRule オブジェクトの配列
GetChildRealm メソッド - レルム下のトップレベル の子レルムを取得
GetChildRealm メソッドは、レルム下のトップレベル の子レルムを取得します。このメソッドは子レルムのみを検索します。
構文
GetChildRealm メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->GetChildRealm(realmName)
[Parameters]
GetChildRealm メソッドは以下のパラメータを受け入れます。
- realmName(文字列)子レルムを確認するレルムを指定します。
戻り値
GetChildRealm メソッドは以下のいずれかの値を返します。
- PolicyMgtRealm オブジェクト
- コールに失敗した場合またはレルムが存在しない場合は、undef
GetDomain メソッド - レルムと関連付けられたドメインを取得
GetDomain メソッドは、レルムと関連付けられたドメインを取得します。
構文
GetDomain メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->GetDomain()
[Parameters]
GetDomain メソッドは、パラメータを受け入れません。
戻り値
GetDomain メソッドは以下のいずれかの値を返します。
- 既存のレルム用の PolicyMgtDomain オブジェクト
- コールに失敗した場合は、undef
GetRule メソッド - レルム内の既存のルールを取得
GetRule メソッドは、レルム内の既存のルールを取得します。
構文
GetRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->GetRule(ruleName)
[Parameters]
GetRule メソッドは以下のパラメータを受け入れます。
- ruleName(文字列)取得するルールの名前を指定します。
戻り値
GetRule メソッドは以下のいずれかの値を返します。
- PolicyMgtRule オブジェクト
- コールに失敗した場合または指定されたルールが存在しない場合は、undef
IdleTimeout メソッド - ユーザがレルムで非アクティブ状態を維持できる最大時間を設定または取得
IdleTimeout メソッドは、再認証が必要になる前に、ユーザがレルムで非アクティブ状態を維持できる最大時間を設定または取得します。
構文
IdleTimeout メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->IdleTimeout([idleTimeout])
[Parameters]
IdleTimeout メソッドは以下のパラメータを受け入れます。
- idleTimeout(タイプ)(オプション)アイドル タイムアウト値を秒単位で指定します。
戻り値
IdleTimeout メソッドは以下のいずれかの値を返します。
- 引数が指定されない場合は、既存のタイムアウト値
- idleTimeoutが指定される場合は、新しいタイムアウト値
- コールに失敗する場合は、-1
MaxTimeout メソッド - ユーザがレルムにアクセスできる最大時間を設定または取得
MaxTimeout メソッドは、再認証が必要になる前に、ユーザがレルムにアクセスできる最大時間を設定または取得します。
構文
MaxTimeout メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->MaxTimeout([maxTimeout])
[Parameters]
MaxTimeout メソッドは以下のパラメータを受け入れます。
- maxTimeout(int)(オプション)最大タイムアウト値を秒単位で指定します。
戻り値
MaxTimeout メソッドは以下のいずれかの値を返します。
- 引数が指定されない場合は、既存の最大タイムアウト値
- maxTimeoutが指定される場合は、新しい最大タイムアウト値。
- コールに失敗する場合は、-1
Name メソッド - レルム名を設定または取得
Name メソッドは、レルム名を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->Name([realmName])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
- realmName(文字列)(オプション)レルムに割り当てる名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
- 新規または既存のレルム名
- コールに失敗した場合は、undef
ProcessAuEvents メソッド - レルムの認証イベント フラグを設定または取得
ProcessAuEvents メソッドは、レルムの認証イベント フラグを設定または取得します。
認証イベント処理はパフォーマンスに影響します。レルムのルールが認証イベントによってトリガされない場合は、このフラグを 0 に設定します。
構文
ProcessAuEvents メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->ProcessAuEvents([authFlag])
[Parameters]
ProcessAuEvents メソッドは以下のパラメータを受け入れます。
- authFlag(int)(オプション)以下のように、認証イベントが処理されるかどうかを指定します。
- イベント処理を有効にするには 1
- イベント処理を無効にするには 0
戻り値
ProcessAuEvents メソッドは以下のいずれかの値を返します。
- 認証イベントを処理する場合は、1
- 認証イベントを処理しない場合は、0
- コールに失敗する場合は、-1
ProcessAzEvents メソッド - レルム内の許可イベント フラグを設定または取得
ProcessAzEvents メソッドは、レルム内の許可イベント フラグを設定または取得します。
構文
ProcessAzEvents メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->ProcessAzEvents([azFlag])
[Parameters]
ProcessAzEvents メソッドは以下のパラメータを受け入れます。
- azFlag(int)(オプション)許可イベント処理を有効にするかどうかを指定します。
- 1 はイベント処理を有効化
- 0 はイベント処理を無効化
戻り値
ProcessAzEvents メソッドは以下のいずれかの値を返します。
- 許可イベントを処理する場合は、1
- 許可イベントを処理しない場合は、0
- コールに失敗する場合は、-1
注釈
認可イベント処理はパフォーマンスに影響します。レルムのルールが許可イベントによってトリガされない場合は、このフラグを 0 に設定します。
ProtectResource メソッド - 現在のリソース保護フラグの例を設定または取得
ProtectResource メソッドは、現在のリソース保護フラグを設定または取得します。
構文
ProtectResource メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->ProtectResource([protectFlag])
[Parameters]
ProtectResource メソッドは以下のパラメータを受け入れます。
- protectFlag(int)(オプション)以下のように、リソース保護を有効にするかどうかを指定します。
- 1 はリソースを保護します
- 0 はリソースを未保護の状態にします
戻り値
ProtectResource メソッドは以下のいずれかの値を返します。
- 引数が指定されない場合は、既存のリソース保護状態(0 または 1)。
- フラグ値がメソッドに渡される場合は、新しいリソース保護状態。
- コールに失敗した場合は、undef
RegScheme メソッド - レルムの登録方式を設定または取得
RegScheme メソッドは、レルムの登録方式を設定または取得します。
構文
RegScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->RegScheme([regScheme])
[Parameters]
RegScheme メソッドは以下のパラメータを受け入れます。
- regScheme(PolicyMgtRegScheme)(オプション)設定する登録方式を指定します。
戻り値
RegScheme メソッドは以下のいずれかの値を返します。
- PolicyMgtRegScheme オブジェクト
- コールに失敗した場合または登録方式が存在しない場合は、undef
SessionDrift メソッド -- セッション ドリフトを設定または取得
SessionDrift メソッドは、レルムのセッション ドリフトを設定または取得します。つまり、永続レルム上で有効な場合の検証期間(秒単位)を表します。
構文
SessionDrift メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->SessionDrift([SessionDrift])
[Parameters]
SessionDrift メソッドは以下のパラメータを受け入れます。
- SessionDrift(int)(オプション)新しい値を指定するか、または指定されていないときに現在値を返します。
戻り値
SessionDrift メソッドは以下のいずれかの値を返します。
- 新規または既存のセッション ドリフト値
- 失敗の場合は、Sm_PolicyApi_Status_t エラー コード-1 (Sm_PolicyApi_Failure)は、セッション ドリフトが有効でないことを示す有効な戻り値です。
ResourceFilter メソッド - レルム リソース フィルタを設定または取得
ResourceFilter メソッドは、レルム リソース フィルタを設定または取得します。
構文
ResourceFilter メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->ResourceFilter([rFilter])
[Parameters]
ResourceFilter メソッドは以下のパラメータを受け入れます。
- rFilter(文字列)(オプション)設定するレルム リソース フィルタを指定します。
戻り値
ResourceFilter メソッドは以下のいずれかの値を返します。
- 新規または既存のレルム フィルタ
- コールに失敗した場合は、undef
SyncAudit メソッド - 同期監査フラグを設定または取得
SyncAudit メソッドは、同期監査フラグを設定または取得します。このフラグが有効な場合は、リソースへのアクセスを許可する前に、
SiteMinder
はポリシー サーバおよびエージェント アクションをログ記録します。構文
SyncAudit メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRealm->SyncAudit([syncFlag])
[Parameters]
SyncAudit メソッドは以下のパラメータを受け入れます。
- syncFlag(int)(オプション)以下のように、同期監査を有効にするかどうかを指定します。
- 1 は同期監査を有効にします
- 0 は同期監査を無効にします
戻り値
SyncAudit メソッドは以下のいずれかの値を返します。
- 引数が指定されない場合は、既存の同期監査値(0 または 1)。
- フラグ引数がメソッドに渡される場合は、新しい同期監査値。
- コールに失敗する場合は、-1