CLI 認証方式メソッド
目次
casso1283
目次
AddMessageConsumerPluginToSAML1xScheme メソッド -- メッセージ コンシューマ プラグイン クラス名を追加
AddMessageConsumerPluginToSAML1xScheme メソッドは、メッセージ コンシューマ プラグイン クラス名およびパラメータを SAML1x 認証方式に追加します。
構文
AddMessageConsumerPluginToSAML1xScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->AddMessageConsumerPluginToSAML1xScheme(pluginClass, pluginParam)
[Parameters]
AddMessageConsumerPluginToSAML1xScheme メソッドは、以下のパラメータを受け入れます。
- pluginClass(文字列)メッセージ コンシューマ プラグイン クラス名を指定します。
- pluginParam(文字列)メッセージ コンシューマ プラグイン パラメータ名を指定します。
戻り値
AddMessageConsumerPluginToSAML1xScheme メソッドは以下のいずれかの値を返します。
- Sm_PolicyApi_Success
- Sm_PolicyApi_Failure
AddRedirectURLToSAML1xScheme メソッド -- 認証方式にリダイレクト値を追加
AddRedirectURLToSAML1xScheme メソッドは、リダイレクト URL、タイプおよびモードを SAML1x 認証方式に追加します。
構文
AddRedirectURLToSAML1xScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->AddRedirectURLToSAML1xScheme(iTypeURL, URL, redirectMode)
[Parameters]
AddRedirectURLToSAML1xScheme メソッドは、以下のパラメータを受け入れます。
- iTypeURL(int)以下のいずれかの値であるリダイレクト URL タイプを指定します。0 -- ユーザが見つからない1 -- 無効なメッセージ2 -- 受け入れられない認証情報
- URL(文字列)リダイレクト URL サイトを指定します。
- redirectMode(int)以下のいずれかの値であるリダイレクト モードを指定します。
- 0 -- 302 データなし
- 1 -- POST
戻り値
AddRedirectURLToSAML1xScheme メソッドは以下のいずれかの値を返します。
- Sm_PolicyApi_Success
- Sm_PolicyApi_Failure
AddTargetConfigToSAML1xScheme メソッド -- デフォルト ターゲット設定を設定
AddTargetConfigToSAML1xScheme メソッドは、デフォルト ターゲットおよび QueryParameterOverridesTarget 設定を SAML1x 認証方式に設定します。
構文
AddTargetConfigToSAML1xScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->AddTargetConfigToSAML1xScheme(pszTargetURL, iQPOverrideTarget)
[Parameters]
AddTargetConfigToSAML1xScheme メソッドは、以下のパラメータを受け入れます。
- pszTargetURL(文字列)デフォルト ターゲット URL を指定します。
- iQPOverrideTarget(int)クエリ パラメータがデフォルト ターゲットの設定を無視するかどうかを指定します。
戻り値
AddTargetConfigToSAML1xScheme メソッドは以下のいずれかの値を返します。
- Sm_PolicyApi_Success
- Sm_PolicyApi_Failure
CustomLib メソッドは、認証方式を実装する共有ライブラリの名前を設定または取得します。
構文
CustomLib メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->CustomLib([libName])
[Parameters]
CustomLib メソッドは以下のパラメータを受け入れます。
- libName(文字列)(オプション)共有ライブラリ名を指定します。
戻り値
CustomLib メソッドは以下のいずれかの値を返します。
- 新規または既存のライブラリ名
- コールに失敗した場合は、undef
注釈
事前定義済み認証方式タイプがそれぞれデフォルト ライブラリと共にリリースされますが、カスタム ライブラリを使用できます。カスタム認証方式を使用する場合は、カスタム ライブラリを指定する必要があります。
CustomParam メソッド - 認証方式に渡される情報を設定または取得
CustomParam メソッドは、認証方式に渡される情報を設定または取得します。認証方式用のデフォルト パラメータを受け入れるか、新しいパラメータを指定できます。
構文
CustomParam メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->CustomParam([param])
[Parameters]
CustomParam メソッドは以下のパラメータを受け入れます。
- param(文字列)(オプション)渡すパラメータ情報を指定します。
戻り値
CustomParam メソッドは以下のいずれかの値を返します。
- 新規または既存のパラメータ情報
- コールに失敗した場合は、NULL 文字列
CustomSecret メソッドは、カスタム認証方式用の共有秘密キーを設定または取得します。
構文
CustomSecret メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->CustomSecret([param])
[Parameters]
CustomSecret メソッドは以下のパラメータを受け入れます。
- param(文字列)(オプション)共有秘密キーを指定します。
戻り値
CustomSecret メソッドは以下のいずれかの値を返します。
- 新規または既存の共有秘密キー
- コールに失敗した場合は、NULL 文字列
Description メソッド - 認証方式の説明を設定または取得
Description メソッドは、認証方式の説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->Description([schemeDesc])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
- schemeDesc(文字列)(オプション)説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
- 新規または既存の認証方式の説明
- コールに失敗した場合は、空の文字列
GetMessageConsumerPluginFromSAML1xScheme メソッド -- メッセージ コンシューマ プラグイン クラス名を取得
GetMessageConsumerPluginFromSAML1xScheme メソッドは、メッセージ コンシューマ プラグイン クラス名およびパラメータを SAML1x 認証方式から取得します。
構文
GetMessageConsumerPluginFromSAML1xScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->GetMessageConsumerPluginFromSAML1xScheme(pluginClass, pluginParam)
[Parameters]
GetMessageConsumerPluginFromSAML1xScheme メソッドは、以下のパラメータを受け入れます。
- pluginClass(文字列)メッセージ コンシューマ プラグイン クラス名を指定します。
- pluginParam(文字列)メッセージ コンシューマ プラグイン パラメータ名を指定します。
戻り値
GetMessageConsumerPluginFromSAML1xScheme メソッドは以下のいずれかの値を返します。
- Sm_PolicyApi_Success
- Sm_PolicyApi_Failure
GetRedirectURLFromSAML1xScheme メソッド -- リダイレクト URL を取得
GetRedirectURLFromSAML1xScheme メソッドは、リダイレクト URL、タイプおよびモードを SAML1x 認証方式から取得します。
構文
GetRedirectURLFromSAML1xScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->GetRedirectURLFromSAML1xScheme(iTypeURL, URL, redirectMode)
[Parameters]
GetRedirectURLFromSAML1xScheme メソッドは、以下のパラメータを受け入れます。
- iTypeURL(int)以下のいずれかの値であるリダイレクト URL タイプを指定します。0 -- ユーザが見つからない1 -- 無効なメッセージ2 -- 受け入れられない認証情報
- URL(文字列)リダイレクト URL サイトを指定します。
- redirectMode(int)以下のいずれかの値であるリダイレクト モードを指定します。
- 0 -- 302 データなし
- 1 -- POST
戻り値
GetRedirectURLFromSAML1xScheme メソッドは以下のいずれかの値を返します。
- Sm_PolicyApi_Success
- Sm_PolicyApi_Failure
GetTargetConfigFromSAML1xScheme メソッド -- デフォルト ターゲット設定を取得
GetTargetConfigFromSAML1xScheme メソッドは、デフォルト ターゲットおよび QueryParameterOverridesTarget 設定を SAML1x 認証方式から取得します。
構文
GetTargetConfigFromSAML1xScheme メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->GetTargetConfigFromSAML1xScheme(pszTargetURL, iQPOverrideTarget)
[Parameters]
GetTargetConfigFromSAML1xScheme メソッドは、以下のパラメータを受け入れます。
- pszTargetURL(文字列)デフォルト ターゲット URL を指定します。
- iQPOverrideTarget(int)クエリ パラメータがデフォルト ターゲットの設定を無視するかどうかを指定します。
戻り値
GetTargetConfigFromSAML1xScheme メソッドは以下のいずれかの値を返します。
- Sm_PolicyApi_Success
- Sm_PolicyApi_Failure
IgnorePwd メソッド - パスワード ポリシーを確認するかどうかを指定
IgnorePwd メソッドは、認証方式用のパスワード ポリシーを確認するかどうかを指定するフラグを設定または取得します。
構文
IgnorePwd メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->IgnorePwd([pwdFlag])
[Parameters]
IgnorePwd メソッドは以下のパラメータを受け入れます。
- pwdFlag(int)(オプション)パスワード ポリシーを無視するかどうか(1 に設定)、または実施するかどうか(0 に設定)を指定します。
戻り値
IgnorePwd メソッドは以下のいずれかの値を返します。
- パスワード ポリシーを無視する場合は、1
- パスワード ポリシーの場合は、0
- コールに失敗した場合は、-1
IsRadius メソッド - 認証方式で RADIUS エージェントをサポートするかどうかを判定
IsRadius メソッドは、認証方式で RADIUS エージェントをサポートするかどうかを指定するフラグを設定または取得します。
構文
IsRadius メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->IsRadius([radFlag])
[Parameters]
IsRadius メソッドは以下のパラメータを受け入れます。
- radFlag(int)(オプション)認証方式で RADIUS エージェントをサポートするかどうかを指定します(1=yes、0=no)。
戻り値
IsRadius メソッドは以下のいずれかの値を返します。
- 認証方式で RADIUS エージェントをサポートする場合は、1
- 認証方式で RADIUS エージェントをサポートしない場合は、0
- コールに失敗した場合は、-1
IsTemplate メソッド - 認証方式がテンプレートかどうかを判定
IsTemplate メソッドは、認証方式がテンプレートかどうかを示すフラグ値を取得します。
構文
IsTemplate メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->IsTemplate( )
[Parameters]
IsTemplate メソッドは、パラメータを受け入れません。
戻り値
IsTemplate メソッドは以下のいずれかの値を返します。
- 認証方式がテンプレートの場合は、1
- 認証方式がテンプレートでない場合は、0
- コールに失敗した場合は、-1
注釈
Perl ポリシー管理 API で認証方式をテンプレートとして設定することは、
SiteMinder
v6.0 SP3 で廃止されました。IsUsedByAdmin メソッド - 管理者を認証するかどうかを判断
IsUsedByAdmin メソッドは、方式を使用して管理者を認証するかどうかを判定します。
構文
IsUsedByAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->IsUsedByAdmin([useAdminFlag])
[Parameters]
IsUsedByAdmin メソッドは以下のパラメータを受け入れます。
- useAdminFlag(int)(オプション)方式を使用して、管理者を認証するかどうかを指定します。
- 方式を管理者認証に使用できるようにする場合は、1
- 方式を管理者認証に使用できないようにする場合は、0
戻り値
IsUsedByAdmin メソッドは以下のいずれかの値を返します。
- 方式を使用して、管理者を認証できる場合は、1
- 方式を使用して、管理者を認証できない場合は、0
- コールに失敗した場合は、-1
Name メソッド - 認証方式の名前を設定または取得
Name メソッドは、認証方式の名前を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->Name([authSchemeName])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
- authSchemeName(文字列)(オプション)認証方式に割り当てる名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
- 新規または既存の認証方式の名前
- コールに失敗した場合は、undef
ProtectionLevel メソッド - 認証方式の保護レベルを設定または取得
ProtectionLevel メソッドは、認証方式の保護レベルを設定または取得します。
構文
ProtectionLevel メソッドの形式は以下のとおりです。
codefirstNetegrity::PolicyMgtAuthScheme->ProtectionLevel([nlevel])
[Parameters]
ProtectionLevel メソッドは以下のパラメータを受け入れます。
- nlevel(int)(オプション)設定する保護レベルを指定します。
戻り値
ProtectionLevel メソッドは以下のいずれかの値を返します。
- 新規または既存の認証方式の保護レベル
- 失敗した場合は、-1
注釈
レベル値の有効範囲は 1 ~ 1000 です。数値が高いほど、方式の保護レベルが高くなります。匿名認証方式では、この値を 0 に設定します。
Save メソッド - ポリシー ストアに認証方式を保存
Save メソッドは、ポリシー ストアに認証方式を保存します。
構文
Save メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->Save( )
[Parameters]
Save メソッドは、パラメータを受け入れません。
戻り値
Save メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- 失敗の場合は -1
- 変更を保存するためのユーザの権限が十分でない場合は、-4
- 方式オブジェクト識別子が見つからない場合は、-100
注釈
認証方式に対して必要なすべての変更を行った後にこのメソッドを 1 回コールします。変更を有効にするには、このメソッドをコールする必要があります。
SaveCredentials メソッド - ユーザ認証情報を保存できるかどうかを判断
SaveCredentials メソッドは、ユーザ認証情報を保存できるようにするフラグを設定または取得します。
構文
SaveCredentials メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->SaveCredentials([credFlag])
[Parameters]
SaveCredentials メソッドは以下のパラメータを受け入れます。
- credFlag(int)(オプション)フラグ値を指定します。
- 認証情報を保存できる場合は、1
- 認証情報を保存できない場合は、0
戻り値
SaveCredentials メソッドは以下のいずれかの値を返します。
- ユーザ認証情報を保存できる場合は、1
- ユーザ認証情報を保存できない場合は、0
Type メソッド - 認証方式タイプを設定または取得
Type メソッドは、認証方式タイプを設定または取得します。
構文
Type メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAuthScheme->Type([template])
[Parameters]
Type メソッドは以下のパラメータを受け入れます。
- template(PolicyMgtAuthScheme)(オプション)認証方式タイプを指定します。
戻り値
Type メソッドは以下のいずれかの値を返します。
- 新規または既存の認証方式タイプ
- コールに失敗した場合は、undef