CLI SAML 2.0 サービス プロバイダ メソッド

ここでは、CLI SAML 2.0 サービス プロバイダ メソッドについて説明します。
casso127jpjp
ここでは、CLI SAML 2.0 サービス プロバイダ メソッドについて説明します。
以下のメソッドが PolicyMgtSAMLServiceProvider オブジェクトに有効です。
  • AddAssertionConsumerService メソッド -- アサーション コンシューマ サービスを SAML サービス プロバイダ オブジェクトに追加
  • AddAttribute メソッド -- 属性を SAML 2.0 サービス プロバイダに追加
  • AddUser メソッド -- SAML サービス プロバイダにユーザを追加
  • CreateIPConfigHostName メソッド -- サービス プロバイダの IP 設定オブジェクトを作成
  • CreateIPConfigRange -- サービス プロバイダの IP 設定オブジェクトを作成
  • CreateIPConfigSingleHost -- サービス プロバイダの IP 設定オブジェクトを作成
  • CreateIPConfigSubnetMask -- サービス プロバイダの IP 設定オブジェクトを作成
  • DeleteIPConfig -- 指定された IP 設定 オブジェクトを削除
  • GetAllAttributes メソッド -- SAML 2.0 サービス プロバイダのすべての属性を取得
  • GetAllIPConfigs メソッド -- すべての IP 設定オブジェクトを取得
  • GetAllAssertionConsumerServices メソッド -- すべてのアサーション コンシューマ サービスを取得
  • GetAllUsers メソッド -- すべてのユーザを取得
  • Property メソッド -- メタデータ プロパティを設定または取得
  • RemoveAssertionConsumer メソッド -- アサーション コンシューマ サービスを削除
  • RemoveAttribute Method -- 指定された属性を削除
  • RemoveUser Method -- 指定されたユーザを削除
  • Save メソッド -- メタデータ プロパティに対して行った変更を保存
AddAssertionConsumerService メソッド - アサーション コンシューマ サービスを SAML サービス プロバイダ オブジェクトに追加
AddAssertionConsumerService メソッドは、アサーション コンシューマ サービスを SAML サービス プロバイダ オブジェクトに追加します。
構文
AddAssertionConsumerService メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->AddAssertionConsumerService(index, protocolBinding, URL)
[Parameters]
AddAssertionConsumerService メソッドは、以下のパラメータを受け入れます。
  1. index
    (int)
    アサーション コンシューマ サービス インデックス化エンドポイント インデックス値を指定します。
  2. protocolBinding
    (文字列)
    以下のいずれかのアサーション コンシューマ サービスのプロトコル バインディングを指定します。
    • SAMLSP_HTTP_Post
    • SAMLSP_ACS_PROTOCOLBINDING_HTTP_Artifact
  3. URL
    (文字列)
    インデックス化エンドポイントの URL を指定します。
戻り値
AddAssertionConsumerService メソッドは以下のいずれかの値を返します。
  • PolicyMgtSAMLSPACS オブジェクト
  • コールに失敗した場合は、
    undef
AddAttribute メソッド - 属性を SAML 2.0 サービス プロバイダに追加
AddAttribute メソッドは、属性を SAML 2.0 サービス プロバイダに追加します。
構文
AddAttribute メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->AddAttribute(attrNameFormat, value, nEncrypted, nMode)
[Parameters]
AddAttribute メソッドは、以下のパラメータを受け入れます。
  1. attrNameFormat
    (int)
    SAML 2.0 標準で定義されるように、以下のいずれかの属性形式を指定します。
    • SAMLSP_UNSPECIFIED(値=0)
    • SAMLSP_URI(値=1)。
    • SAMLSP_BASIC(値=2)。
  2. value
    (文字列)
属性の値指定情報を指定します。この値指定は、[
CA Single Sign-on
SAML サービス プロバイダ プロパティ]ダイアログの[名前と値のペア]列に表示されます。値指定情報の形式は、以下のように追加するアフィリエイト属性のタイプによって異なります -- スタティック、ユーザ属性または DN 属性。
スタティック属性:
variableName=value
  • ユーザ属性:
    variableName=<%userattr="AttrName"%>
  • DN 属性:
    variableName=<#dn="DNSpec" attr="AttrName"#>
    CA Single Sign-on
    で、ネストされたグループから DN 属性を取得できるようにするには、DNSpec の最初に感嘆符(!)を付けます。たとえば、次のようにします。
    dn="!ou=People,o=security.com"
nEncrypted
(int)
属性が暗号化されるかどうかを指定します。ゼロ以外の場合、属性はアサーションに含まれた後に暗号化されます。
nMode
(int)
以下のいずれかのこの属性の取得モードを指定します。
  • SAMLSP_SSO
  • SAMLSP_Attribute
戻り値
AddAttribute メソッドは以下のいずれかの値を返します。
  • PolicyMgtSAMLSPAttr オブジェクト
  • コールに失敗した場合は、
    undef
注釈
SAML 2.0 属性には、サービス プロバイダ上のリソースにアクセスしようとするプリンシパルに関する情報が含まれます。たとえば、プリンシパルのユーザ DN などです。
定義された属性は、このサービス プロバイダに対して生成されるすべての SAML 2.0 アサーション用の属性ステートメントに含まれます。
AddUser メソッド - ユーザを SAML 2.0 サービス プロバイダに追加
AddUser メソッドは、ユーザを SAML サービス プロバイダに追加します。アサーションはサービス プロバイダと関連付けられたユーザに対して生成できます。
構文
AddUser メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->AddUser(user)
[Parameters]
AddUser メソッドは以下のパラメータを受け入れます。
  1. user
    (PolicyMgtUser)
    追加するユーザを指定します。
戻り値
AddUser メソッドは以下のいずれかの値を返します。
  • 成功の場合は 0
  • コールに失敗する場合は、-1
CreateIPConfigHostName メソッド - サービス プロバイダの IP 設定オブジェクトを作成
CreateIPConfigHostName メソッドは、指定されたホスト名に基づいて、サービス プロバイダの IP 設定オブジェクトを作成します。
構文
CreateIPConfigHostName メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->CreateIPConfigHostName(hostName)
[Parameters]
CreateIPConfigHostName メソッドは、以下のパラメータを受け入れます。
  1. hostName
    (文字列)
    アサーションを発行する必要があるホスト名を指定します。
戻り値
CreateIPConfigHostName メソッドは以下のいずれかの値を返します。
  • PolicyMgtIPConfig オブジェクト
  • コールに失敗した場合は、
    undef
注釈
このメソッドは、アサーション生成ポリシー用の IP アドレス制限を作成します。このアドレス制限では、指定されたホストから生成されたアサーションのみが受け入れられます。
CreateIPConfigRange メソッド - サービス プロバイダの IP 設定オブジェクトを作成
CreateIPConfigRange メソッドは、指定された IP アドレスの範囲に基づいて、サービス プロバイダの IP 設定オブジェクトを作成します。
構文
CreateIPConfigRange メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->CreateIPConfigRange(ipAddr1, ipAddr2)
[Parameters]
CreateIPConfigRange メソッドは、以下のパラメータを受け入れます。
  1. ipAddr1
    (文字列)
    有効なアドレス範囲内の最初の IP アドレスを指定します。
  2. ipAddr2
    (文字列)
    有効なアドレス範囲内の最後の IP アドレスを指定します。
戻り値
CreateIPConfigRange メソッドは以下のいずれかの値を返します。
  • PolicyMgtIPConfig オブジェクト
  • コールに失敗した場合は、
    undef
注釈
このメソッドは、アサーション生成ポリシー用の IP アドレス制限を作成します。このアドレス制限では、指定された IP アドレスの範囲から生成されたアサーションのみが受け入れられます。
CreateIPConfigSingleHost メソッド - サービス プロバイダの IP 設定オブジェクトを作成
CreateIPConfigSingleHost メソッドは、指定された IP アドレスに基づいて、サービス プロバイダの IP 設定オブジェクトを作成します。
構文
CreateIPConfigSingleHost メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->CreateIPConfigSingleHost(ipAddr)
[Parameters]
CreateIPConfigSingleHost メソッドは以下のパラメータを受け入れます。
  1. ipAddr
    (文字列)
    アサーションを発行する必要がある IP アドレスを指定します。
戻り値
CreateIPConfigSingleHost メソッドは以下のいずれかの値を返します。
  • PolicyMgtIPConfig オブジェクト
  • コールに失敗した場合は、
    undef
注釈
このメソッドは、アサーション生成ポリシー用の IP アドレス制限を作成します。このアドレス制限では、指定された IP アドレスから生成されたアサーションのみが受け入れられます。
CreateIPConfigSubnetMask メソッド - サービス プロバイダの IP 設定オブジェクトを作成
CreateIPConfigSubnetMask メソッドは、指定された IP アドレスおよびサブネット マスクに基づいて、サービス プロバイダの IP 設定オブジェクトを作成します。
構文
CreateIPConfigSubnetMask メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->CreateIPConfigSubnetMask(ipAddr, subnetMask)
[Parameters]
CreateIPConfigSubnetMask メソッドは、以下のパラメータを受け入れます。
  1. ipAddr
    (文字列)
    サブネット アドレスを引き出すために使用する IP アドレスを指定します。
  2. subnetMask
    (署名なし long)
    サブネット アドレスを引き出すために使用するサブネット マスクを指定します。
戻り値
CreateIPConfigSubnetMask メソッドは以下のいずれかの値を返します。
  • PolicyMgtIPConfig オブジェクト
  • コールに失敗した場合は、
    undef
注釈
このメソッドは、アサーション生成ポリシー用の IP アドレス制限を作成します。このアドレス制限では、サブネット マスクから生成されたアサーションのみが受け入れられます。サブネット アドレスは、渡された IP アドレスおよびサブネット マスクから引き出されます。サブネット マスク値の定義の詳細については、PolicyMgtPolicy>CreateIPConfigSubnetMask メソッドの説明を参照してください。
DeleteIPConfig メソッド - IP 設定オブジェクトを削除
DeleteIPConfig メソッドは、指定された IP 設定オブジェクトを削除します。
構文
DeleteIPConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->DeleteIPConfig(IPConfig)
[Parameters]
DeleteIPConfig メソッドは以下のパラメータを受け入れます。
  1. IPConfig
    (PolicyMgtIPConfig オブジェクト)
    削除する IP 設定オブジェクトを指定します。
戻り値
DeleteIPConfig メソッドは以下のいずれかの値を返します。
  • 値 = 0
    メソッドが成功したことを指定します。
  • 値 = -1
    メソッドが失敗したことを指定します。
GetAllAttributes メソッド - SAML 2.0 サービス プロバイダのすべての属性を取得
GetAllAttributes メソッドは、SAML 2.0 サービス プロバイダ用に定義されたすべての属性を取得します。
構文
GetAllAttributes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->GetAllAttributes() (returCode)
[Parameters]
GetAllAttributes メソッドは、以下のパラメータを受け入れます。
  • returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAttributes メソッドは以下の値を返します。
  • PolicyMgtSAMLSPAttr(配列)
GetAllIPConfigs メソッド - すべての IP 設定オブジェクトを取得
GetAllAttributes メソッドは、SAML 2.0 サービス プロバイダのすべての IP 設定オブジェクトを取得します。
構文
GetAllIPConfigs メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->GetAllIPConfigs() (returnCode)
[Parameters]
GetAllIPConfigs メソッドは、以下のパラメータを受け入れます。
  • returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllIPConfigs メソッドは以下の値を返します。
  • PolicyMgtIPConfig(配列)
GetAllAssertionConsumerServices メソッド - すべてのアサーション コンシューマ サービスを取得
GetAllAssertionConsumerServices メソッドは、SAML 2.0 サービス プロバイダ オブジェクトからすべてのアサーション コンシューマ サービスを取得します。
構文
GetAllAssertionConsumerServices メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->GetAllAssertionConsumerServices() (returnCode)
[Parameters]
GetAllAssertionConsumerServices メソッドは、以下のパラメータを受け入れます。
  • returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAssertionConsumerServices メソッドは以下の値を返します。
  • PolicyMgtSAMLSPACS(配列)
GetAllUsers メソッド - すべてのユーザを取得
GetAllUsers メソッドは、SAML 2.0 サービス プロバイダと関連付けられたすべてのユーザを取得します。ユーザ ディレクトリが指定される場合は、指定されたディレクトリに属すユーザのみが返されます。
構文
GetAllUsers メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->GetAllUsers([userDir]) (returnCode)
[Parameters]
GetAllUsers メソッドは以下のパラメータを受け入れます。
  1. userDir
    (PolicyMgtUserDir オブジェクト)
    (オプション)取得されたすべてのユーザが属す必要があるユーザ ディレクトリを指定します。
  2. returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllUsers メソッドは以下の値を返します。
  • PolicyMgtUser(配列)
Property メソッド - メタデータ プロパティを設定または取得
Property メソッド -- このサービス プロバイダ用に指定された SAML 2.0 メタデータ プロパティを設定または取得します。
: このメソッドを使用して 1 つ以上のサービス プロバイダ プロパティを変更した後で、PolicyMgtSAMLServiceProvider->Save メソッドをコールして変更をポリシー ストアに書き込みます。
構文
Property メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->Property(name[, value])
[Parameters]
Property メソッドは、以下のパラメータを受け入れます。
  1. name
    (文字列)
    設定または取得するプロパティを指定します。
    注:
    サービス プロバイダ メタデータ プロパティの全リストについては、メソッド PolicyMgtAffDomain>CreateSAMLServiceProvider を参照してください。
  2. value
    (文字列)
    (オプション)プロパティの新しい値を指定します。
戻り値
Property メソッドは以下のいずれかの値を返します。
  • property_value
    プロパティの新規または既存の値を指定します。
  • undef
    コールが失敗したことを指定します。
RemoveAssertionConsumer メソッド - アサーション コンシューマ サービスを削除
RemoveAssertionConsumer メソッドは、SAML 2.0 サービス プロバイダから既存のアサーション コンシューマ サービスを削除します。
構文
RemoveAssertionConsumer メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->RemoveAssertionConsumer(pSAMLSPACS)
[Parameters]
RemoveAssertionConsumer メソッドは以下のパラメータを受け入れます。
  1. pSAMLSPACS
    削除するアサーション コンシューマ サービスを指定します。
戻り値
RemoveAssertionConsumer メソッドは以下のいずれかの値を返します。
  • 値 = 0
    メソッドが成功したことを指定します。
  • 値 = -1
    メソッドが失敗したことを指定します。
RemoveAttribute メソッド - 指定された属性を削除
RemoveAttribute メソッドは、SAML 2.0 サービス プロバイダから指定された属性を削除します。
構文
RemoveAttribute メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->RemoveAttribute(SAMLSPAttr)
[Parameters]
RemoveAttribute メソッドは以下のパラメータを受け入れます。
  1. SAMLSPAttr(PolicyMgtSAMLSPAttr オブジェクト)
    削除する属性を指定します。
戻り値
RemoveAttribute メソッドは以下のいずれかの値を返します。
  • 値 = 0
    メソッドが成功したことを指定します。
  • 値 = -1
    メソッドが失敗したことを指定します。
RemoveUser メソッド - 指定されたユーザを削除
RemoveUser メソッドは、SAML 2.0 サービス プロバイダから指定されたユーザを削除します。
構文
RemoveUser メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->RemoveUser(user)
[Parameters]
RemoveUser メソッドは以下のパラメータを受け入れます。
  1. user
    (PolicyMgtUser オブジェクト)
    削除するユーザを指定します。
戻り値
RemoveUser メソッドは以下のいずれかの値を返します。
  • 値 = 0
    メソッドが成功したことを指定します。
  • 値 = -1
    メソッドが失敗したことを指定します。
Save メソッド - メタデータ プロパティに対して行った変更を保存
Save メソッドは、サービス プロバイダの SAML 2.0 メタデータ プロパティに対して行った変更を保存します。SAML 2.0 サービス プロバイダに対してすべての変更を行った後で、このメソッドを 1 回コールします。変更を有効にするには、必ずこのメソッドをコールします。メタデータ プロパティを変更するには、PolicyMgtSAMLServiceProvider->Property メソッドをコールします。
構文
Save メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSAMLServiceProvider->Save()
[Parameters]
Save メソッドは、パラメータを受け入れません。
戻り値
Save メソッドは以下のいずれかの値を返します。
  • 値 = 0
    メソッドが成功したことを指定します。
  • 値 = -1
    メソッドが失敗したことを指定します。
  • 値 = -4
    メタデータ プロパティを変更するのに必要な権限がユーザにないことを指定します。
  • 値 = -10
    パスとクラスが空であることを指定します。