CLI アフィリエイト ドメイン メソッド

ここでは、CLI アフィリエイト ドメイン メソッドについて説明します。
casso127jpjp
ここでは、CLI アフィリエイト ドメイン メソッドについて説明します。
AddAdmin メソッド - アフィリエイト ドメインと管理者を関連付け
AddAdmin メソッドは、アフィリエイト ドメインと管理者を関連付けます。
構文
AddAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->AddAdmin(admin)
パラメータ
AddAdmin メソッドは以下のパラメータを受け入れます。
  1. admin
    (PolicyMgtAdmin)
    アフィリエイト ドメインと関連付ける管理者を指定します。
戻り値
AddAdmin メソッドは以下のいずれかの値を返します。
成功の場合は 0
失敗の場合は -1
 
AddUserDir メソッド - アフィリエイト ドメインとユーザ ディレクトリを関連付け
AddUserDir メソッドは、アフィリエイト ドメインとユーザ ディレクトリを関連付けます。
構文
メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->AddUserDir(userDir)
パラメータ
AddUserDir メソッドは以下のパラメータを受け入れます。
  1. userDir
    (PolicyMgtUserDir)
    アフィリエイト ドメインと関連付けるユーザ ディレクトリを指定します。
戻り値
AddUserDir メソッドは以下のいずれかの値を返します。
成功の場合は 0
失敗の場合は -1
CreateAffiliate メソッド - アフィリエイト オブジェクトを作成
CreateAffiliate メソッドは、アフィリエイト ドメイン内のアフィリエイト オブジェクトを作成し設定します。
構文
CreateAffiliate メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->CreateAffiliate( affName, password, authURL, validityDuration, skewTime [, affDesc] [, allowNotification] [, audience] [, enableFlag] [, shareSessioning] [, sessionSyncInterval] [, SAMLVersion] [, SAMLProfile] [,ConsumerURL] )
[Parameters]
CreateAffiliate メソッドは、以下のパラメータを受け入れます。
  1. affName
    (文字列)
    アフィリエイト オブジェクトの名前を指定します。名前はすべてのアフィリエイト ドメインにわたって一意である必要があります。
  2. password
    (文字列)
    アフィリエイトで
    CA Single Sign-on
    フェデレーション Web サービスにアクセスするために使用するパスワードを指定します。
  3. authURL
    (文字列)
    アフィリエイト ユーザの認証に使用する URL を指定します。
  4. validityDuration
    (long)
    CA Single Sign-on
    によって生成された SAML アサーションが有効な秒数を指定します。アフィリエイトが指定された時間の後にアサーションを受信すると、アサーションが無効であると見なされます。
  5. skewTime
    (long)
    アサーション プロデューサ サイトのシステム クロック時間とアフィリエイト サイトのシステム クロック時間の間の秒単位の違いを指定します。スキュー時間はvalidityDuration に追加されます。時間は GMT が基準になります。
  6. affDesc
    (文字列)
    (オプション)アフィリエイトの説明を指定します。
  7. allowNotification
    (int)
    (オプション)イベント通知を許可するかどうかを指定します。アサーション プロデューサ サイト上でアフィリエイトから
    CA Single Sign-on
    にイベント通知を送信できるようにするには、1 に設定します。イベント通知サービスを無効にするには、0 に設定します。デフォルトは 0 です(通知は無効化)。
  8. audience
    (文字列)
(オプション)アサーション プロデューサとアフィリエイト間の許諾契約について説明するドキュメントの URI。この値はアフィリエイトに渡された SAML アサーションに含まれており、検証目的に使用できます。また、アフィリエイトは、関連情報を取得するためにオーディエンス ドキュメントを解析できます。オーディエンス値は、SAML アフィリエイト エージェント用の AffiliateConfig.xml 設定ファイル内の Assertion Audience 設定に一致する必要があります。
  1. enableFlag
    (int)
    (オプション)アフィリエイト オブジェクトを有効にするかどうかを指定します。アフィリエイト オブジェクトを有効にするには 1 に設定し、無効にするには、0 に設定します。デフォルトは 1 です(オブジェクトは有効化)。
  2. shareSessioning
    (int)
    (オプション)セッション情報を共有するかどうかを指定します。アサーション プロデューサおよびアフィリエイトでセッション情報を共有できるようにするには 1 に設定し、プロデューサおよびアフィリエイトで個別セッションを維持するには 0 に設定します。デフォルトは 0 です(セッションを共有せず)。共有セッションでは、一方のサイト上のセッションが終了すると、両方のサイト上のセッションが終了します。
  3. sessionSyncInterval
    (long)
    (オプション)アフィリエイトが共有セッションのステータスを検証するためにプロデューサ サイトにアクセスする頻度を秒単位で指定します。
  4. SAMLVersion
    (long)
    (オプション)SAML バージョンを指定します。以下の値のいずれかです。
    • AFFILIATE_SAML_VER_1_0
    • AFFILIATE_SAML_VER_1_1
    SAML バージョンの指定は、ポリシー マネージャ API のセッション バージョンが少なくとも v6.0 SP 1 である場合にのみ有効です。
  5. SAMLProfile
    (long)
    (オプション)SAML アサーションの送信および受信に使用されるプロファイルのタイプを指定します。有効なプロファイルは以下のとおりです。
    AFFILIATE_SAML_PROFILE_ARTIFACT。SAML アサーションは、アサーション プロデューサと関連付けられた URL から取得されます。URL は SAML アーチファクト認証方式の設定時に指定されます。
    AFFILIATE_SAML_PROFILE_POST。生成された SAML アサーションは、ConsumerURL で指定された URL に対して POST 処理されます。
    ポリシー管理 API のセッション バージョンが少なくとも v6.0 SP 2 である場合にのみ、このプロファイルがサポートされます。以前のバージョンが含まれている場合、POST プロファイル要求は無視されます。また、アーチファクト プロファイルに基づいてアフィリエイト オブジェクトを作成するように試行されます。
  6. ConsumerURL
    (文字列)
    (オプション)要求するユーザのブラウザで、生成されたアサーションを POST 処理する必要がある URL を指定します。この URL と関連付けられたサイトは、アサーションを検証し、その内容を使用してアクセスを決定します。
戻り値
CreateAffiliate メソッドは以下のいずれかの値を返します。
成功した場合は、PolicyMgtAffiliate オブジェクト
失敗した場合は、
undef
注釈
アフィリエイト オブジェクトは、フェデレートされたビジネス ネットワーク内のアフィリエイト サイトを表します。アフィリエイト オブジェクトおよびアフィリエイト ドメインは、
CA Single Sign-on
eTrust
CA Single Sign-on
FSS を通じて利用可能です。
CreateSAMLServiceProvider メソッド - SAML サービス プロバイダを作成
CreateSAMLServiceProvider メソッドは、SAML 2.0 サービス プロバイダ オブジェクトを作成します。サービス プロバイダ オブジェクトには、サービス プロバイダ用のアサーションを生成するためにアイデンティティ プロバイダが必要とする情報が含まれています。SAML 2.0 サービス プロバイダ オブジェクト用に設定できるプロパティを以下にリストします。
既存のサービス プロバイダのプロパティを変更するには、PolicyMgtSAMLServiceProvider>Property メソッドをコールします。
構文
CreateSAMLServiceProvider メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->CreateSAMLServiceProvider(propsHash_ref)
[Parameters]
CreateSAMLServiceProvider メソッドは以下のパラメータを受け入れます。
  1. propsHash_ref
    (ハッシュ)
    SAML 2.0 サービス プロバイダ用に定義されたメタデータ プロパティのハッシュテーブルの参照を指定します(たとえば、\%myhash)。
戻り値
CreateSAMLServiceProvider メソッドは以下のいずれかの値を返します。
  • 成功した場合は、PolicyMgtSAMLServiceProvider オブジェクト
  • 失敗の場合は
    undef
注釈
SAML 2.0 サービス プロバイダ オブジェクト用に以下のプロパティを定義できます。
General Properties
SAML_NAME
  • SAML_DESCRIPTION
  • SAML_SP_AUTHENTICATION_URL
  • SAML_ENABLED
  • SAML_SP_DOMAIN
  • SAML_KEY_SPID
  • SAML_SP_IDPID
  • SAML_MAJOR_VERSION
  • SAML_MINOR_VERSION
  • SAML_SKEWTIME
  • SAML_DISABLE_SIGNATURE_PROCESSING
  • SAML_DSIG_VERINFO_ISSUER_DN
  • SAML_DSIG_VERINFO_SERIAL_NUMBERSAML_KEY_SPID
名前 ID プロパティ
SAML_SP_NAMEID_FORMAT
  • SAML_SP_NAMEID_TYPE
  • SAML_SP_NAMEID_STATIC
  • SAML_SP_NAMEID_ATTRNAME
  • SAML_SP_NAMEID_DNSPEC
  • SAML_AFFILIATION
SSO プロパティ
SAML_AUDIENCE
  • SAML_SP_ASSERTION_CONSUMER_DEFAULT_URL
  • SAML_ENABLE_SSO_ARTIFACT_BINDING
  • SAML_SP_ARTIFACT_ENCODING
  • SAML_SP_IDP_SOURCEID
  • SAML_SP_PASSWORD
  • SAML_ENABLE_SSO_POST_BINDING
  • SAML_SSOECPPROFILE
  • SAML_SP_REQUIRE_SIGNED_AUTHNREQUESTS
  • SAML_SP_AUTHENTICATION_LEVEL
  • SAML_SP_AUTHN_CONTEXT_CLASS_REF
  • SAML_SP_VALIDITY_DURATION
  • SAML_SP_STARTTIME
  • SAML_SP_ENDTIME
SLO プロパティ
SAML_SLO_REDIRECT_BINDING
  • SAML_SLO_SERVICE_VALIDITY_DURATION
  • SAML_SLO_SERVICE_URL
  • SAML_SLO_SERVICE_RESPONSE_URL
  • SAML_SLO_SERVICE_CONFIRM_URL
IPD プロパティ
SAML_SP_ENABLE_IPD
  • SAML_SP_IPD_SERVICE_URL
  • SAML_SP_COMMON_DOMAIN
  • SAML_SP_PERSISTENT_COOKIE
属性サービス プロパティ
SAML_SP_ATTRSVC_ENABLE
  • SAML_SP_ATTRSVC_VALIDITY_DURATION
  • SAML_SP_ATTRSVC_SIGN_ASSERTION
  • SAML_SP_ATTRSVC_LDAP_SEARCH_SPEC
  • SAML_SP_ATTRSVC_ODBC_SEARCH_SPEC
  • SAML_SP_ATTRSVC_WINNT_SEARCH_SPEC
  • SAML_SP_ATTRSVC_CUSTOM_SEARCH_SPEC
  • SAML_SP_ATTRSVC_AD_SEARCH_SPEC
暗号化プロパティ
SAML_SP_ENCRYPT_ID
  • SAML_SP_ENCRYPT_ASSERTION
  • SAML_SP_ENCRYPT_BLOCK_ALGO
  • SAML_SP_ENCRYPT_KEY_ALGO
  • SAML_SP_ENCRYPT_CERT_ISSUER_DN
  • SAML_SP_ENCRYPT_CERT_SERIAL_NUMBER
詳細プロパティ
SAML_SP_PLUGIN_CLASS
  • SAML_SP_PLUGIN_PARAMS
CreateWSFEDResourcePartner メソッド - WS-Federation リソース パートナーを作成
CreateWSFEDResourcePartner メソッドは、アフィリエイト ドメイン用の WS-Federation リソース パートナーを作成します。
構文
CreateWSFEDResourcePartner メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->CreateWSFEDResourcePartner(propsHash_ref)
[Parameters]
CreateWSFEDResourcePartner メソッドは、以下のパラメータを受け入れます。
  1. propsHash_ref
    (ハッシュ)
    次の定義を行う場合のメタデータ プロパティのハッシュテーブルの参照を指定します。
    WS-Federation リソース パートナー、(たとえば、C<\%myhash>|"hashref")
戻り値
CreateWSFEDResourcePartner メソッドは以下のいずれかの値を返します。
  • 成功した場合は、PolicyMgtWSFEDResourcePartner オブジェクト
  • 失敗の場合は
    undef
注釈
リソース パートナー用に以下のプロパティを定義できます。
General Properties
WSFED_NAME
  • WSFED_DESCRIPTION
  • WSFED_MAJOR_VERSION
  • WSFED_MINOR_VERSION
  • WSFED_SAML_MAJOR_VERSION
  • WSFED_KEY_RPID
  • WSFED_APID
  • WSFED_SAML_MINOR_VERSION
  • WSFED_RP_DOMAIN
  • WSFED_ENABLED
  • WSFED_RP_AUTHENTICATION_URL
  • WSFED_KEY_RPID
  • WSFED_APID
名前 ID プロパティ
WSFED_RP_NAMEID_FORMAT
  • WSFED_RP_NAMEID_TYPE
  • WSFED_RP_NAMEID_STATIC
  • WSFED_RP_NAMEID_ATTR_NAME
  • WSFED_RP_NAMEID_DN_SPEC
  • WSFED_RP_NAMEID_ALLOWED_NESTED
SSO プロパティ
WSFED_RP_AUTHENTICATION_METHOD
  • WSFED_RP_VALIDITY_DURATION
  • WSFED_RP_ASSERTION_CONSUMER_DEFAULT_URL
  • WSFED_RP_AUTHENTICATION_LEVEL
  • WSFED_RP_STARTTIME
  • WSFED_RP_ENDTIME
サインアウト プロパティ
WSFED_RP_SLO_ENABLED
  • WSFED_RP_SIGNOUT_CLEANUP_URL
  • WSFED_RP_SIGNOUT_CONFIRM_URL
詳細プロパティ
WSFED_RP_PLUGIN_CLASS
  • WSFED_RP_PLUGIN_PARAMS
DeleteAffiliate メソッド - ドメインからアフィリエイトを削除
DeleteAffiliate メソッドは、アフィリエイト ドメインから指定されたアフィリエイト オブジェクトを削除します。
構文
DeleteAffiliate メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->DeleteAffiliate(aff)
[Parameters]
DeleteAffiliate メソッドは、以下のパラメータを受け入れます。
  1. aff
    (PolicyMgtAffiliate)
    削除するアフィリエイト オブジェクトを指定します。
戻り値
DeleteAffiliate メソッドは以下のいずれかの値を返します。
  • 成功した場合またはアフィリエイト ドメインが見つからなかった場合は 0
  • 失敗の場合は -1
DeleteSAMLServiceProvider メソッド - SAML サービス プロバイダを削除
DeleteSAMLServiceProvider メソッドは、指定された SAML 2.0 サービス プロバイダを削除します。
構文
メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->DeleteSAMLServiceProvider(sp)
[Parameters]
DeleteSAMLServiceProvider メソッドは、以下のパラメータを受け入れます。
  1. sp
    (PolicyMgtSAMLServiceProvider)
    削除するサービス プロバイダを指定します。
戻り値
DeleteSAMLServiceProvider メソッドは以下のいずれかの値を返します。
  • 成功した場合またはサービス プロバイダが見つからなかった場合は 0
  • 失敗の場合は -1
DeleteWSFEDResourcePartner メソッド - リソース パートナーを削除
DeleteWSFEDResourcePartner メソッドは、リソース パートナーを削除します。
構文
DeleteWSFEDResourcePartner メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->DeleteWSFEDResourcePartner(rp)
[Parameters]
DeleteWSFEDResourcePartner メソッドは以下のパラメータを受け入れます。
  1. rp
    (PolicyMgtWSFEDResourcePartner オブジェクト)
    削除するリソース パートナーを指定します。
戻り値
DeleteWSFEDResourcePartner メソッドは以下のいずれかの値を返します。
  • 値 = 0
    メソッドが成功したことを指定します。
  • 値 = -1
    メソッドが失敗したことを指定します。
Description メソッド - 説明を取得または設定
Description メソッドは、アフィリエイト ドメインの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->Description([domainDesc])
[Parameters]
Description メソッドは、以下のパラメータを受け入れます。
  1. domainDesc
    (文字列)
    (オプション)設定する説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
  • 成功の場合は、アフィリエイト ドメインの新規または既存の説明
  • 失敗の場合は
    undef
 
GetAffiliate メソッド - アフィリエイト オブジェクトを取得
GetAffiliate メソッドは、指定されたアフィリエイト オブジェクトを取得します。
構文
GetAffiliate メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetAffiliate(affName)
[Parameters]
GetAffiliate メソッドは、以下のパラメータを受け入れます。
  1. affName
    (文字列)
    取得するアフィリエイト オブジェクトの名前を指定します。
戻り値
GetAffiliate メソッドは以下のいずれかの値を返します。
  • 成功したときの PolicyMgtAffiliate オブジェクト
  • 指定されたアフィリエイト オブジェクトが存在しない場合またはコールに失敗する場合は、
    undef
GetAllAdmins メソッド - すべての管理者を取得
GetAllAdmins メソッドは、アフィリエイト ドメインと関連付けられたすべての管理者を取得します。
構文
GetAllAdmins メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetAllAdmins() [(returnCode)]
[Parameters]
GetAllAdmins メソッドは、以下のパラメータを受け入れます。
  • (オプション)
    returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAdmins メソッドは以下の1個以上の値を返します。
  • PolicyMgtAdmin オブジェクトの配列
GetAllAffiliates メソッド - ドメイン内のすべてのアフィリエイトを取得
GetAllAffiliates メソッドは、アフィリエイト ドメインと関連付けられたすべてのアフィリエイト オブジェクトを取得します。
構文
GetAllAffiliates メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetAllAffiliates( ) [(
returnCode
)]
[Parameters]
GetAllAffiliates メソッドは、以下のパラメータを受け入れます。
  • (オプション)
    returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAffiliates メソッドは以下の値を返します。
  • 成功の場合は、PolicyMgtAffiliate オブジェクトの配列
GetAllSAMLServiceProviders メソッド - アフィリエイト ドメインと関連付けられたすべてのサービス プロバイダを取得
GetAllSAMLServiceProviders メソッドは、アフィリエイト ドメインと関連付けられたすべての SAML 2.0 サービス プロバイダを取得します。
構文
GetAllSAMLServiceProviders メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetAllSAMLServiceProviders( ) [(returnCode)]
[Parameters]
GetAllSAMLServiceProviders メソッドは、以下のパラメータを受け入れます。
  • (オプション)
    returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllSAMLServiceProviders メソッドは以下の値を返します。
  • PolicyMgtSAMLServiceProvider オブジェクトの配列
GetAllWSFEDResourcePartners メソッド - すべての WSFED リソース パートナーを取得
GetAllWSFEDResourcePartners メソッドは、ドメインと関連付けられたすべてのリソース パートナーを取得します。
構文
GetAllWSFEDResourcePartners メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetAllWSFEDResourcePartners( ) [(
returnCode
)]
[Parameters]
GetAllWSFEDResourcePartners メソッドは、以下のパラメータを受け入れます。
  • (オプション)
    returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllWSFEDResourcePartners メソッドは以下の値を返します。
  • 成功の場合は、PolicyMgtWSFEDResourcePartner オブジェクトの配列
GetSAMLServiceProvider メソッド - 指定されたサービス プロバイダを取得
GetSAMLServiceProvider メソッドは、指定された SAML 2.0 サービス プロバイダを取得します。
構文
GetSAMLServiceProvider メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetSAMLServiceProvider(spName)
[Parameters]
GetSAMLServiceProvider メソッドは以下のパラメータを受け入れます。
  1. spName
    (文字列)
    取得するサービス プロバイダの名前を指定します。
戻り値
GetSAMLServiceProvider メソッドは以下のいずれかの値を返します。
  • 成功した場合は、PolicyMgtSAMLServiceProvider オブジェクト
  • 指定されたサービス プロバイダが存在しない場合またはコールに失敗する場合は、undef
GetSAMLServiceProviderByID メソッド - 指定されたサービス プロバイダを取得
GetSAMLServiceProviderById メソッドは、そのプロバイダ ID によって、指定された SAML 2.0 サービス プロバイダを取得します。
構文
GetSAMLServiceProviderById メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetSAMLServiceProviderById(spID)
[Parameters]
GetSAMLServiceProviderById メソッドは以下のパラメータを受け入れます。
  1. spID
    (文字列)
    取得するサービス プロバイダのプロバイダ ID を指定します。
戻り値
GetSAMLServiceProviderById メソッドは以下のいずれかの値を返します。
  • 成功した場合は、PolicyMgtSAMLServiceProvider オブジェクト
  • 指定されたサービス プロバイダが存在しない場合またはコールに失敗する場合は、
    undef
GetUserDirSearchOrder メソッド - ユーザ ディレクトリの検索順序を取得
GetUserDirSearchOrder メソッドは、アフィリエイト ドメインと関連付けられたユーザ ディレクトリ オブジェクトを取得します。返されるオブジェクトの順序は、ディレクトリのクエリ実行時に
CA Single Sign-on
が使用する順序と同じです。
構文
GetUserDirSearchOrder メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetUserDirSearchOrder( )
[Parameters]
GetUserDirSearchOrder メソッドは、以下のパラメータを受け入れます。
  • (オプション)
    returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetUserDirSearchOrder メソッドは以下の値を返します。
  • 成功の場合は、PolicyMgtUserDir オブジェクトの配列
GetWSFEDResourcePartner メソッド - リソース パートナーを取得
GetWSFEDResourcePartner メソッドは、ドメインと関連付けられた指定の WS-Federation リソース パートナーを取得します。
構文
GetWSFEDResourcePartner メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetWSFEDResourcePartner(rpName)
[Parameters]
GetWSFEDResourcePartner メソッドは、以下のパラメータを受け入れます。
  1. rpName
    (文字列)
    取得するリソース パートナーの名前を指定します。
戻り値
GetWSFEDResourcePartner メソッドは、以下の値を返します。
  • 成功した場合は、PolicyMgtWSFEDResourcePartner オブジェクト
  • 指定されたリソース パートナーが存在しない場合またはコールに失敗する場合は、
    undef
GetWSFEDResourcePartnerById メソッド - ID によってリソース パートナーを取得
GetWSFEDResourcePartnerById メソッドは、そのプロバイダ ID によって、指定されたリソース パートナーを取得します。
構文
GetWSFEDResourcePartnerById メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->GetWSFEDResourcePartnerById( rpID )
[Parameters]
GetWSFEDResourcePartnerById メソッドは、以下のパラメータを受け入れます。
  1. rpID
    (文字列)
    取得するリソース パートナーの ID を指定します。
戻り値
GetWSFEDResourcePartnerById メソッドは、以下の値を返します。
  • PolicyMgtWSFEDResourcePartner オブジェクト
  • 指定されたリソース パートナーが存在しない場合またはコールに失敗する場合は、
    undef
Name メソッド - アフィリエイト ドメインの名前を設定または取得
Name メソッドは、アフィリエイト ドメインの名前を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->Name( [domainName] )
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
  1. domainName
    (文字列)
    (オプション)設定する名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
  • 新規または既存のアフィリエイト ドメイン名
  • コールに失敗した場合は、
    undef
RemoveAdmin メソッド - アフィリエイト ドメインから管理者の関連付けを解除
RemoveAdmin メソッドは、アフィリエイト ドメインから指定された管理者の関連付けを解除します。
構文
RemoveAdmin メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->RemoveAdmin( admin )
[Parameters]
RemoveAdmin メソッドは以下のパラメータを受け入れます。
  1. admin
    (PolicyMgtAdmin)
    アフィリエイト ドメインから削除する管理者を指定します。
戻り値
RemoveAdmin メソッドは以下のいずれかの値を返します。
  • 成功の場合は 0
  • 失敗の場合は -1
RemoveUserDir メソッド - アフィリエイト ドメインからユーザ ディレクトリの関連付けを解除
RemoveUserDir メソッドは、アフィリエイト ドメインからユーザ ディレクトリの関連付けを解除します。
構文
RemoveUserDir メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->RemoveUserDir( userDir )
[Parameters]
RemoveUserDir メソッドは以下のパラメータを受け入れます。
  1. userDir
    (PolicyMgtUserDir)
    アフィリエイト ドメインから関連付けを解除するユーザ ディレクトリを指定します。
戻り値
RemoveUserDir メソッドは以下のいずれかの値を返します。
  • 成功の場合は 0
  • 失敗の場合は -1
SetUserDirSearchOrder メソッド - ディレクトリ オブジェクトの検索順序を設定
SetUserDirSearchOrder メソッドは、アフィリエイト ドメインと関連付けられたユーザ ディレクトリ オブジェクトの検索順序を再調整します。
構文
SetUserDirSearchOrder メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffDomain->SetUserDirSearchOrder( dirArray )
[Parameters]
SetUserDirSearchOrder メソッドは以下のパラメータを受け入れます。
  1. dirArray
    (PolicyMgtUserDir)
    ユーザ ディレクトリ オブジェクトの配列の参照を指定します(たとえば、\@myarray)。
戻り値
SetUserDirSearchOrder メソッドは、以下の値を返します。
  • 成功の場合は、(PolicyMgtUserDir)オブジェクトの配列
  • 失敗した場合は、
    undef