CLI SAML 2.0 アフィリエーション メソッド
ここでは、CLI SAML 2.0 アフィリエーション メソッドについて説明します。
casso127jpjp
ここでは、CLI SAML 2.0 アフィリエーション メソッドについて説明します。
GetAffiliatedSAMLAuthSchemes メソッド - この SAML アフィリエーションと関連付けられたすべての SAML 2.0 認証方式を取得
GetAffiliatedSAMLAuthSchemes メソッドは、この SAML アフィリエーションと関連付けられたすべての SAML 2.0 認証方式を取得します。
構文
GetAffiliatedSAMLAuthSchemes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLAffiliation->GetAffiliatedSAMLAuthSchemes() (returnCode)
[Parameters]
GetAffiliatedSAMLAuthSchemes メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAffiliatedSAMLAuthSchemes メソッドは以下の値を返します。
- SAML 2.0 テンプレートに基づく PolicyMgtAuthScheme オブジェクトの配列
GetAffiliatedSAMLServiceProviders メソッド - この SAML アフィリエーションと関連付けられたすべての SAML 2.0 サービス プロバイダを取得
GetAffiliatedSAMLServiceProviders メソッドは、この SAML アフィリエーションと関連付けられたすべての SAML 2.0 サービス プロバイダを取得します。
構文
GetAffiliatedSAMLServiceProviders メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLAffiliation->GetAffiliatedSAMLServiceProviders() (returnCode)
[Parameters]
GetAffiliatedSAMLServiceProviders メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAffiliatedSAMLServiceProviders メソッドは以下の値を返します。
- PolicyMgtSAMLServiceProvider オブジェクトの配列
Property メソッド - SAML 2.0 メタデータ プロパティを設定または取得
Property メソッド -- この SAML 2.0 アフィリエーションの指定された SAML 2.0 メタデータ プロパティを設定または取得します。
構文
Property メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLAffiliation->Property(name [, value])
[Parameters]
Property メソッドは、以下のパラメータを受け入れます。
- name(文字列)設定または取得するプロパティを指定します。
- value(文字列)(オプション)設定するプロパティの値を指定します。
戻り値
Property メソッドは以下のいずれかの値を返します。
- 新規または既存のプロパティ値
- コールに失敗した場合は、undef
注釈
アフィリエーション メタデータ プロパティのリストについては、PolicyMgtSession>CreateSAMLAffiliation メソッドの説明を参照してください。
注: このメソッドで 1 つ以上の既存のアフィリエーション プロパティを変更した後で、PolicyMgtSAMLAffiliation>Save をコールして変更をポリシー ストアに書き込みます。
Save メソッド - この SAML 2.0 アフィリエーションの SAML 2.0 メタデータ プロパティに対して行った変更を保存
Save メソッドは、この SAML 2.0 アフィリエーションの SAML 2.0 メタデータ プロパティに対して行った変更を保存します。
構文
Save メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLAffiliation->Save()
[Parameters]
Save メソッドは、パラメータを受け入れません。
戻り値
Save メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗する場合は、-1
- 変更を保存するためのユーザの権限が十分でない場合は、-4
- パスとクラスが空の場合は、-10
注釈
アフィリエーション プロパティを変更するには、PolicyMgtSAMLAffiliation->Property メソッドをコールします。