5 Identity FederationのWLSTコマンド

この章では、Oracle Access Management Identity Federation (Identity Federation)のカスタムWebLogic Scripting Tool (WLST)コマンドについて、コマンド構文、引数および例を含めて説明します。

Identity FederationのWLSTコマンドは、2つのカテゴリに編成されています。次の項では、カテゴリ別のIdentity FederationのWLSTコマンドと、コマンド・リファレンスの詳細へのリンクを示します。

• Identity Federationのコマンド

• Advanced Identity Federationのコマンド

注意: Identity FederationのWLSTコマンドは、キーと値のペアまたは値のみの指定で属性を取りますが、Oracle Access Management Access Managerはキーと値のペアのみを取ります。そのため、このドキュメントのWLSTの例は、いずれかの方法で定義できます。このWLSTの例では、キーと値の組合せを使用します。 setIdPPartnerAttributeProfileEntry(attrProfileID="openid-idp-attribute-profile", messageAttributeName="http://axschema.org/namePerson", oamSessionAttributeName="name", requestFromIdP="true")

Identity Federationのコマンド

表5-1に示すWLSTコマンドを使用して、フェデレーション・パートナとパートナのプロファイルを構成します。

注意: Identity Federationのコマンドの定義は、"addWSFed11IdPFederationPartner"で開始します。

表5-1 Identity FederationのWLSTコマンド

使用するコマンド	目的	WLSTでの使用
addWSFed11IdPFederationPartner	WS-Fed 1.1 IdPパートナを作成します。	オンライン
addWSFed11SPFederationPartner	WS-Fed 1.1 SPパートナを作成します。	オンライン
addOpenID20IdPFederationPartner	OpenID 2.0 IdPパートナを作成します。	オンライン
addOpenID20SPFederationPartner	OpenID 2.0 SPパートナを作成します。	オンライン
addOpenID20GoogleIdPFederationPartner	Google OpenID 2.0 IdPパートナを作成します。	オンライン
addOpenID20YahooIdPFederationPartner	Yahoo OpenID 2.0 IdPパートナを作成します。	オンライン
addSAML11IdPFederationPartner	SAML 1.1プロトコルのもとでIdPフェデレーション・パートナを作成します(メタデータを含みます)。	オンライン
addSAML11SPFederationPartner	SAML 1.1プロトコルのもとでSPフェデレーション・パートナを作成します(メタデータを含みます)。	オンライン
addSAML20IdPFederationPartner	SAML 2.0プロトコルのもとでIdPフェデレーション・パートナを作成します。	オンライン
addSAML20SPFederationPartner	SAML 2.0プロトコルのもとでSPフェデレーション・パートナを作成します。	オンライン
addSAML20IdPFederationPartnerWithoutMetadata	SAML 2.0プロトコルのもとで、メタデータをインポートせずにIdPフェデレーション・パートナを作成します。	オンライン
addSAML20SPFederationPartnerWithoutMetadata	SAML 2.0プロトコルのもとで、メタデータをインポートせずにSPフェデレーション・パートナを作成します。	オンライン
configureIdPPartnerAttributeProfile	プロファイルの一部ではない着信属性を無視するかどうかを指定するIdPパートナ属性プロファイルを構成します。	オンライン
configureSAML20Logout	SAML 2.0フェデレーション・パートナのグローバル・フェデレーション・ログアウトを構成します。	オンライン
configureSAMLBinding	SAMLフェデレーション・パートナの優先バインディングを構成します。	オンライン
configureUserSelfRegistration	ユーザーの自己登録を有効にします。	オンライン
configureUserSelfRegistrationAttr	自己登録の際に、アサーションからのどの属性を電子メール、名、姓またはユーザー名として使用する必要があるかを設定します。	オンライン
createAuthnSchemeAndModule	IdPパートナの認証スキームおよびモジュールを作成します。	オンライン
createIdPPartnerAttributeProfile	フェデレーション・パートナのIdPパートナ属性プロファイルを作成します。	オンライン
createSPPartnerAttributeProfile	フェデレーション・パートナのSPパートナ属性プロファイルを作成します。	オンライン
deleteAuthnSchemeAndModule	IdPパートナの認証スキームおよびモジュールを削除します。	オンライン
deleteFederationPartner	特定のフェデレーション・パートナを削除します。	オンライン
deleteFederationPartnerEncryptionCert	フェデレーション・パートナの暗号化証明書を削除します。	オンライン
deleteFederationPartnerSigningCert	フェデレーション・パートナの署名証明書を削除します。	オンライン
deleteIdPPartnerAttributeProfile	IdPフェデレーション・パートナの属性プロファイルを削除します。	オンライン
deleteSPPartnerAttributeProfile	SPフェデレーション・パートナの属性プロファイルを削除します。	オンライン
deleteIdPPartnerAttributeProfileEntry	フェデレーション・パートナの属性プロファイルからエントリを削除します。	オンライン
deleteSPPartnerAttributeProfileEntry	フェデレーション・パートナの属性プロファイルからエントリを削除します。	オンライン
deletePartnerProperty	パートナの構成に追加されたパートナ固有のプロパティを削除します。	オンライン
displayIdPPartnerAttributeProfile	IdPフェデレーション・パートナの属性プロファイルを表示します。	オンライン
displaySPPartnerAttributeProfile	SPフェデレーション・パートナの属性プロファイルを表示します。	オンライン
getAllFederationIdentityProviders	すべてのIdPフェデレーション・パートナを一覧表示します。	オンライン
getFederationPartnerEncryptionCert	フェデレーション・パートナの暗号化証明書を取得します。	オンライン
getFederationPartnerSigningCert	フェデレーション・パートナの署名証明書を取得します	オンライン
getIdPPartnerBasicAuthCredentialUsername	フェデレーション・パートナのHTTP Basic認証ユーザー名を取得します。	オンライン
getPartnerProperty	フェデレーション・パートナのプロパティを取得します。	オンライン
getStringProperty	フェデレーション・パートナ・プロファイルから文字列プロパティを取得します。	オンライン
isFederationPartnerPresent	パートナが構成されているかどうかをチェックします。	オンライン
listIdPPartnerAttributeProfileIDs	IdPパートナの属性プロファイルを一覧表示します。	オンライン
listSPPartnerAttributeProfileIDs	SPパートナの属性プロファイルを一覧表示します。	オンライン
putStringProperty	デフォルトのフェデレーションIdPとしてOpenIDパートナを設定します。	オンライン
setDefaultSSOIdPPartner	IdPパートナを、フェデレーション・シングル・サインオンのデフォルトのアイデンティティ・プロバイダとして設定します。	オンライン
setFederationPartnerEncryptionCert	フェデレーション・パートナの暗号化証明書を設定します。	オンライン
setFederationPartnerSigningCert	フェデレーション・パートナの署名証明書を設定します。	オンライン
setIdPPartnerAttributeProfile	IdPパートナとのフェデレーテッド・シングル・サインオンで使用する属性プロファイルを設定します。	オンライン
setIdPDefaultScheme	デフォルトのOAM認証スキームを設定します。	オンライン
setSPPartnerAttributeProfile	SPパートナとのフェデレーテッド・シングル・サインオンで使用する属性プロファイルを設定します。	オンライン
setIdPPartnerAttributeProfileEntry	IdPフェデレーション・パートナのプロファイル内のエントリを設定します。	オンライン
setSPPartnerAttributeProfileEntry	SPフェデレーション・パートナのプロファイル内のエントリを設定します。	オンライン
setIdPPartnerBasicAuthCredential	フェデレーション・パートナのHTTP Basic認証資格証明を更新します。	オンライン
setIdPPartnerMappingAttribute	フェデレーション・パートナのアサーション・マッピングに使用される属性を設定します。	オンライン
setIdPPartnerMappingAttributeQuery	フェデレーション・パートナのアサーション・マッピングに使用される属性問合せを設定します。	オンライン
setIdPPartnerMappingNameID	IdPフェデレーション・パートナのアサーション・マッピングnameID値を設定します	オンライン
setPartnerAlias	フェデレーション・パートナの別名を更新します。	オンライン
setPartnerIDStoreAndBaseDN	フェデレーション・パートナのアイデンティティ・ストアおよびベースDNを設定します。	オンライン
setSPPartnerAlternateScheme	別の認証スキームを構成します。	オンライン
setSPPartnerDefaultScheme	デフォルトの認証スキームを構成します。	オンライン
setSPPartnerProfileDefaultScheme	デフォルトの認証スキームでプロファイルを構成します。	オンライン
setSPPartnerProfileAlternateScheme	別の認証スキームでプロファイルを構成します。	オンライン
updatePartnerMetadata	フェデレーション・パートナのメタデータを更新します。	オンライン
updatePartnerProperty	フェデレーション・パートナのプロパティを更新します。	オンライン

Advanced Identity Federationのコマンド

Advanced Identity FederationのWLSTコマンドには、Oracle Access Managementコンソールの構成で該当する管理フィールドがありません。認証マッピングの管理とパートナ・プロファイルはWLSTコマンドを使用してのみ利用できます。表5-2に、この項に記載するAdvanced Identity Federationのコマンドを示します。コマンドは次のように編成されています。

• フェデレーション・サービスとデータストア

• フェデレーション・アクセスの構成

• 属性共有の構成

• 認証メソッド・マッピング管理 - すべての認証メソッド/スキーマ/レベルのマッピングは、パートナ・レベル、あるいはパートナ・レベルで定義されない場合はパートナ・プロファイル・レベルでWLSTを使用して構成されます。

• パートナ・プロファイル管理 - すべてのパートナ・プロファイル管理はWLSTを使用して行います。

• WLSTとSAML 1.1の使用

注意: Advanced Identity Federationのコマンドの定義は、"configureFederationService"で開始します。

表5-2 Advanced Identity FederationのWLSTコマンド

使用するコマンド	目的	WLSTでの使用
フェデレーション・サービスとデータストア
configureFederationService	Federation Serviceの機能を有効または無効にします。
setFederationStore	フェデレーション・ストアを有効にして構成します。
フェデレーション・アクセスの構成
configureIdPAuthnRequest	Force AuthenticationまたはIsPassive、あるいはその両方のIdPパートナまたはIdPパートナ・プロファイルを構成します。
configureFedSSOAuthz	フェデレーションSSOの認可を有効または無効にします。
configureFedDigitalSignature	デジタル署名で使用されるハッシュ・アルゴリズムの構成
configureFedSignEncKey	デジタル署名および暗号化操作に使用する署名キー別名または暗号化キー別名、あるいはその両方を構成します。
属性共有の構成
configureAttributeSharingSPPartnerNameIDMapping	属性共有中に使用するNameIDからユーザー・ストア属性へのマッピングを構成します。
configureAttributeSharingIdPPartner	IdPパートナのデフォルトの属性共有nameidおよびnameid形式を構成します。
configureAttributeSharingUserDNToIdPPartnerMapping	属性共有DNからIdPへのマッピングを構成します。
configureAttributeSharing	デフォルトの属性オーソリティを設定して属性共有機能を構成します。
removeAttributeSharingFromAuthnModule	認証モジュールから属性共有プラグインを削除します。
configureAttributeSharingPlugin	特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。
insertAttributeSharingInToAuthnModule	属性共有ステップを認証モジュール・フローに挿入します。
認証メソッド・マッピング管理
setSPPartnerAlternateScheme	別の認証スキーム(パートナ)でクライアントを認証する方法を提供します。
setSPPartnerDefaultScheme	SPパートナのデフォルトの認証スキームを定義します。
setSPPartnerProfileAlternateScheme	別の認証スキーム(パートナ・プロファイル)でクライアントを認証する方法を提供します。
setSPPartnerProfileDefaultScheme	特定のSPパートナ・プロファイルのユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。
addSPPartnerAuthnMethod	フェデレーテッド認証メソッドと特定のSPパートナのAccess Manager認証スキームの間のマッピングを定義します。
addSPPartnerProfileAuthnMethod	フェデレーテッド認証メソッドから特定のSPパートナ・プロファイルのAccess Manager認証スキームへのマッピングを定義します。
addIdPPartnerAuthnMethod	特定のIdPパートナのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。
addIdPPartnerProfileAuthnMethod	特定のIdPパートナ・プロファイルのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。
listPartnerAuthnMethods	特定のパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。
listPartnerProfileAuthnMethods	特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。
removePartnerAuthnMethod	フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。
removePartnerProfileAuthnMethod	フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。
setIdPPartnerRequestAuthnMethod	特定のIdPパートナのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。
setIdPPartnerProfileRequestAuthnMethod	指定したIdPパートナ・プロファイルのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。
useProxiedFedAuthnMethod	フェデレーションSSOを実行するときに、プロキシ処理されたフェデレーテッド認証メソッドを使用するアイデンティティ・プロバイダを構成します。
パートナ・プロファイル管理
createFedPartnerProfileFrom	指定した既存のプロファイルに基づいてフェデレーション・パートナ・プロファイルを作成します。
deleteFedPartnerProfile	指定したフェデレーション・パートナ・プロファイルを削除します。
displayFedPartnerProfile	指定したフェデレーション・パートナ・プロファイルで定義されているプロパティを表示します。
listFedPartnerProfiles	既存のすべてのフェデレーション・パートナ・プロファイルを一覧表示します。
listFedPartnersForProfile	指定したフェデレーション・パートナ・プロファイルにバインドされたパートナを一覧表示します。
getFedPartnerProfile	指定したパートナにバインドされたパートナ・プロファイルのIDを取得します。
setFedPartnerProfile	指定したパートナのフェデレーション・パートナ・プロファイルのIDを設定します。
SAML 1.1でのWLSTの使用
IDPパートナがSAML 1.1に対して構成されている場合、SSOプロセスを開始するために次のURLがSPによって使用されます。 http://idphost:idpport/ssourl?TARGET=targeturl&providerid=http://spproviderid これらのWLSTコマンドを使用することで、URLに該当する情報を移入できます。
idpinitiatedssoprovideridparam	値は、SPのプロバイダIDを識別するためにピア・プロバイダが使用します。
idpinitiatedssotargetparam	指定したSPパートナのターゲットURLを設定します。
次のSAML 1.1構成パラメータは、Oracle Access Managementコンソールからは公開されません。これらのパラメータの値は、WLSTを使用して変更できます。
「deletePartnerProperty」	パートナ・プロパティを削除します。
「getPartnerProperty」	パートナ・プロパティを取得します。
「updatePartnerProperty」	パートナ・プロパティを更新します。
サブジェクト確認チェック
subjectconfirmationcheck	SAMLアサーションのサブジェクト確認データ・チェックを有効または無効にします。

addWSFed11IdPFederationPartner

WS-Federation 1.1 IdPパートナを作成します。

説明

WS-Federation 1.1プロトコルのもとでIdPパートナを作成します。NameIDは、LDAPユーザー・メール属性にマップされます。

構文

addWSFed11IdPFederationPartner(partnerName,ssoURL, providerID, description) 

引数	定義
partnerName	作成するパートナの名前。
ssoURL	ユーザーがWS-Federation 1.1操作のIdPでリダイレクトされるアイデンティティ・レルム・セキュア・トークンURL。
providerID	SAMLアサーションで使用されるプロバイダID/発行者。
description	パートナの説明。省略可能。

例

addWSFed11IdPFederationPartner("testpartner1", "http://idp.com/wsfed11",
 "http://idp.com", description="WS-Fed IdP1")

addWSFed11SPFederationPartner

WS-Federation 1.1 SPパートナを作成します。

説明

WS-Federation 1.1プロトコルのもとでSPパートナを作成します。

構文

addWSFed11SPFederationPartner(partnerName, realm, ssoURL, samlVersion, msftADFSCompatible, description) 

引数	定義
partnerName	作成するパートナの名前。
realm	このSPパートナのレルム識別子。これは、WS-Federation 1.1プロトコル交換で使用されます。
ssoURL	ユーザーがWS-Federation 1.1操作のSPでリダイレクトされるアイデンティティ・レルム・セキュア・トークンURL。
samlVersion	どの種類のアサーションを発行するかを示すオプションのSAMLバージョン。値saml11 (デフォルト)またはsaml20を取ります。
msftADFSCompatible	発行されたSSOレスポンスを、Microsoft ADFS互換形式WS-Trust 1.2またはWS-Trust 1.3にする必要があるかどうかを示すオプションのブール値。
description	パートナの説明。省略可能。

例

addWSFed11SPFederationPartner("testpartner1", "http://sp.com",
 "http://sp.com/wsfed11", description="Test SP1")

addOpenID20IdPFederationPartner

OpenID 2.0 IdPパートナを作成します。

説明

OpenID 2.0プロトコルのもとでIdPパートナを作成します。

構文

addOpenID20IdPFederationPartner(partnerName, idpSSOURL, discoveryURL, description) 

引数	定義
partnerName	作成するパートナの名前。
idpSSOURL	IdPの起動SSO URL。検出URLを指定し、かつそれを使用する場合は、""に設定できます。
discoveryURL	IdPのOpenID検出URL。
description	パートナの説明。省略可能。

例

addOpenID20IdPFederationPartner("testpartner1", "", 
 "http://host:port/discoveryurl", description="Test IdP1")

addOpenID20SPFederationPartner

OpenID 2.0 SPパートナを作成します。

説明

OpenID 2.0プロトコルのもとでSPパートナを作成します。

構文

addOpenID20SPFederationPartner(partnerName, realm, ssoURL, description) 

引数	定義
partnerName	作成するパートナの名前。
realm	SP (RP)のレルム。
ssoURL	SP (RP)のエンドポイントURL。
description	パートナの説明。省略可能。

例

addOpenID20SPFederationPartner(partnerName="partnerID", 
 realm="http://realm.domain.com", ssoURL="http://host:port/endpoint", 
 description="some description")

addOpenID20GoogleIdPFederationPartner

googleという名前のIdPパートナを作成します。

説明

検出URL https://www.google.com/accounts/o8/idを使用して、googleという名前のIdPパートナを作成します。

構文

addOpenID20GoogleIdPFederationPartner()

例

addOpenID20GoogleIdPFederationPartner()

addOpenID20YahooIdPFederationPartner

yahooという名前のIdPパートナを作成します。

説明

検出URL https://open.login.yahooapis.com/openid20/user_profile/xrdsを使用して、yahooという名前のIdPパートナを作成します。

構文

addOpenID20YahooIdPFederationPartner()

例

addOpenID20YahooIdPFederationPartner()

addSAML11IdPFederationPartner

SAML 1.1 IdPフェデレーション・パートナを作成します。

説明

SAML 1.1 IdPフェデレーション・パートナを作成します。

構文

addSAML11IdPFederationPartner(partnerName,providerID, ssoURL,
soapURL, succinctID, description)

引数	定義
partnerName	作成するパートナの名前。
providerID	パートナのproviderID。
ssoURL	IdPの起動SSO URL。
soapURL	IdPのアーティファクト解決SOAPエンドポイントURL。
succinctID	プロバイダのsuccinctID。
description	パートナの説明。省略可能。

例

addSAML11IdPFederationPartner(partnerName="partnerID",
providerID="providerA", ssoURL="http://host:port/saml11sso",
soapURL="http://host:port/soapurl", succinctID="1234", 
description="somedescription")

addSAML11SPFederationPartner

SAML 1.1 SPフェデレーション・パートナを作成します。

説明

SAML 1.1 SPフェデレーション・パートナを作成します。

構文

addSAML11SPFederationPartner(partnerName,providerID, ssoURL, description)

引数	定義
partnerName	作成するパートナの名前。
providerID	パートナのproviderID。
ssoURL	IdPの起動SSO URL。
description	パートナの説明。省略可能。

例

addSAML11SPFederationPartner(partnerName="partnerID", providerID="providerA", 
ssoURL="http://host:port/saml11sso", description="somedescription")

addSAML20IdPFederationPartner

SAML 2.0 IdPフェデレーション・パートナを作成します。

説明

SAML 2.0プロトコルのもとでフェデレーション・パートナをAccess Managerのアイデンティティ・プロバイダとして作成し、ファイルからパートナ・メタデータをロードします。

構文

addSAML20IdPFederationPartner(partnerName, metadataFile, description)

引数	定義
partnerName	作成するパートナの名前。
metadataFile	メタデータ・ファイルの場所(フルパス)。
description	パートナの説明。省略可能。

例

addSAML20IdPFederationPartner(partnerName="partnerID", 
metadataFile="location_metadata_file", description="somedescription")

addSAML20SPFederationPartner

SAML 2.0 SPフェデレーション・パートナを作成します。

説明

SAML 2.0プロトコルのもとでフェデレーション・パートナをAccess Managerのサービス・プロバイダとして作成し、ファイルからパートナ・メタデータをロードします。

構文

addSAML20SPFederationPartner(partnerName, metadataFile, description)

引数	定義
partnerName	作成するパートナの名前。
metadataFile	メタデータ・ファイルの場所(フルパス)。
description	パートナの説明。省略可能。

例

addSAML20SPFederationPartner(partnerName="partnerID", 
metadataFile="location_metadata_file", description="somedescription")

addSAML20IdPFederationPartnerWithoutMetadata

SAML 2.0メタデータなしでSAML20 IdPフェデレーション・パートナを作成します。

説明

SAML 2.0メタデータをロードせずにSAML20 IdPフェデレーション・パートナを作成します。

構文

addSAML20IdPFederationPartnerWithoutMetadata(partnerName,
providerID, ssoURL, soapURL, succinctID, description)

引数	定義
partnerName	作成するフェデレーション・パートナの名前。
providerID	パートナのproviderID。
ssoURL	IdPの起動SSO URL。
soapURL	IdPのアーティファクト解決SOAPエンドポイントURL。
succinctID	プロバイダのsuccinctID。
description	パートナの説明。省略可能。

例

addSAML20IdPFederationPartnerWithoutMetadata(partnerName="partnerName", providerID="http://host:port", ssoURL="http://host:port/saml/sso", soapURL="http://host:port/saml/soap",description="some description")

addSAML20SPFederationPartnerWithoutMetadata

SAML 2.0メタデータなしでSAML20 SPフェデレーション・パートナを作成します。

説明

SAML 2.0メタデータをロードせずにSAML20 SPフェデレーション・パートナを作成します。

構文

addSAML20SPFederationPartnerWithoutMetadata(partnerName,
providerID, ssoURL, description)

引数	定義
partnerName	作成するフェデレーション・パートナの名前。
providerID	パートナのproviderID。
ssoURL	IdPの起動SSO URL。
description	パートナの説明。省略可能。

例

addSAML20SPFederationPartnerWithoutMetadata(partnerName="partnerName", providerID="http://host:port", ssoURL="http://host:port/saml/sso", description="somedescription")

configureIdPPartnerAttributeProfile

着信属性を処理するようにIdPパートナ属性プロファイルを構成します。

説明

プロファイル内に定義されていない着信属性を処理または無視するようにIdPパートナ属性プロファイルを構成します。

構文

configureIdPPartnerAttributeProfile(attrProfileID, ignoreUnmappedAttributes)

引数	定義
attrProfileID	構成するIdPパートナ属性プロファイルを参照する識別子。
ignoreUnmappedAttributes	プロファイル内に定義されていない着信属性を無視するかどうかを決定します。 有効な値は、true(無視)または(デフォルト)false(処理)です。

例

configureIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile", 
ignoreUnmappedAttributes="false")

configureSAML20Logout

SAML 2.0パートナのグローバル・フェデレーション・ログアウトを構成します。

説明

SAML 2.0フェデレーション・パートナのグローバル・フェデレーション・ログアウトを構成します。

構文

configureSAML20Logout(partnerName, partnerType, enable,
saml20LogoutRequestURL, saml20LogoutResponseURL, soapURL)

引数	定義
partnerName	更新するパートナのID。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるか。 有効な値は、sp、idpです。
enable	そのパートナのグローバル・ログアウトを有効または無効にします。 有効な値は、true(有効)またはfalse(無効)です。
saml20LogoutRequestURL	SAML 2.0ログアウト・リクエスト・サービスURL。 パートナがメタデータを使用して作成された場合、またはログアウトが無効な場合は、オプションです。
saml20LogoutResponseURL	SAML 2.0ログアウト・レスポンス・サービスURL。 これは、パートナがメタデータを使用して作成された場合、またはログアウトが無効な場合は、オプションです。
soapURL	SAML 2.0 SOAPサービスURL。これは、パートナがメタデータを使用して作成された場合、ログアウトが無効な場合、またはSOAPログアウトがサポートされていない場合は、オプションです。

例

configureSAML20Logout(partnerName="partnerID", partnerType="sp", enable="true",
saml20LogoutRequestURL="http://host:port/saml/logoutrequest",
saml20LogoutResponseURL="http://host:port/saml/logoutresponse",
soapURL="http://host:port/saml/soap")

configureSAMLBinding

SAMLパートナのバインディングを指定します。

説明

SAMLパートナの優先バインディングを構成します。

構文

configureSAMLBinding(partnerName, partnerType, binding, ssoResponseBinding="httppost")

引数	定義
partnerName	構成するパートナの名前。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを示します。有効な値は、sp、idpです。
binding	SSO応答以外のメッセージに使用するバインディングを指定します(認証リクエスト、ログアウト・メッセージ)。有効なオプションは、HTTP-POSTバインディングの場合はhttppost、HTTPリダイレクト・バインディングの場合はhttpredirectです。
ssoResponseBinding	このオプションの属性は、SSO応答に使用するバインディングを定義します。有効なオプションは、HTTP-POSTバインディングの場合はhttppost(デフォルト値)、HTTPリダイレクト・バインディングの場合はhttpredirect、アーティファクト・バインディングの場合はartifactです。

例

configureSAMLBinding(partnerName="partnerID", 
partnerType="sp", binding="httpredirect", ssoResponseBinding="httppost")

configureUserSelfRegistration

ユーザー自己登録モジュールを有効にします。

説明

ユーザー自己登録モジュールを有効にします。

構文

configureUserSelfRegistration(<enabled>, <registrationURL>, 
 <regDataRetrievalAuthnEnabled>, <regDataRetrievalAuthnUsername>, 
 <regDataRetrievalAuthnPassword>, <partnerName>) 

引数	定義
enabled	ユーザー自己登録モジュールが有効になっているかどうかを示します。値としてtrueまたはfalseを取ります。
registrationURL	自己登録のためにユーザーがリダイレクトされる場所です。partnerNameが指定されず、registrationURLが空であるか欠落している場合、現行のプロパティは変更されません。partnerNameが指定され、registrationURLが空であるか欠落している場合、このプロパティはパートナの構成から削除されます。
regDataRetrievalAuthnEnabled	登録データを取得するためにサーバーに接続するときに登録ページの認証が有効になっているかどうかを示します。
regDataRetrievalAuthnUsername	サーバーから登録データを取得するときに登録ページがサーバーに送信するユーザー名を指定します。
regDataRetrievalAuthnPassword	サーバーから登録データを取得するときに登録ページがサーバーに送信するパスワードを指定します。
partnerName	自己登録を有効にするIdPパートナを示します。欠落している場合、構成はグローバルに作用します。

例

configureUserSelfRegistration("true", regDataRetrievalAuthnEnabled="true", 
 regDataRetrievalAuthnUsername="username", 
 regDataRetrievalAuthnPassword="password")

configureUserSelfRegistrationAttr

アサーションの中のどの属性が電子メール、名、姓およびユーザー名として使用されるかを設定します。

説明

アサーションの中のどの属性が電子メール、名、姓およびユーザー名として使用されるかを設定します。

構文

configureUserSelfRegistration(<registrationAttrName>, <assertionAttrNames>, 
 <partnerName>) 

引数	定義
registrationAttrName	設定する自己登録ページの属性。次の値のいずれか1つを設定できます: email、firstname、lastnameまたはusername。
assertionAttrNames	registrationAttrNameとして指定される自己登録ページのフィールドに移入するために使用できる、アサーションの設定可能な属性。
partnerName	ユーザー自己登録を構成するIdPパートナを示します。欠落している場合、構成はグローバルに作用します。

例

configureUserSelfRegistrationAttr("email", "mail,fed.nameidvalue") 

2番目のパラメータは、アサーションからのmailまたはfed.nameidvalueをユーザーの自己登録ページでemail属性に移入できることを示します。

createAuthnSchemeAndModule

OpenD IdPを使用する認証スキームを作成します。

説明

OpenD IdPを使用する認証スキームを作成して、Access Managerのリソースを保護します。

構文

createAuthnSchemeAndModule(partnerName)

引数	定義
partnerName	スキームの作成対象となるパートナの名前。

例

createAuthnSchemeAndModule("testpartner")

createIdPPartnerAttributeProfile

IdP属性プロファイルを作成します。

説明

着信SAMLアサーション内の属性の処理に使用される名前マッピング・ルールを含むIdPパートナ属性プロファイルを作成します

構文

createIdPPartnerAttributeProfile(attrProfileID)

引数	定義
attrProfileID	IdP属性プロファイルの識別子。

例

createIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")

createSPPartnerAttributeProfile

SP属性プロファイルを作成します。

説明

着信SAMLアサーション内の属性の処理に使用される名前マッピング・ルールを含むSPパートナ属性プロファイルを作成します

構文

createSPPartnerAttributeProfile(attrProfileID)

引数	定義
attrProfileID	SP属性プロファイルの識別子。

例

createSPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")

deleteAuthnSchemeAndModule

IdPの認証スキームを削除します。

説明

IdPパートナの認証スキームを削除します。

構文

deleteAuthnSchemeAndModule(partnerName)

引数	定義
partnerName	スキームの削除対象となるパートナの名前。

例

deleteAuthnSchemeAndModule("testpartner")

deleteFederationPartner

フェデレーション・パートナを削除します。

説明

Access Managerからフェデレーション・パートナを削除します。

構文

deleteFederationPartner(partnerName, partnerType)

引数	定義
partnerName	削除するパートナのID。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。

例

deleteFederationPartner(partnerName="partnerID", partnerType="idp")

deleteFederationPartnerEncryptionCert

パートナの暗号化証明書を削除します。

説明

フェデレーション・パートナの暗号化証明書を削除します。

構文

deleteFederationPartnerEncryptionCert(partnerName, partnerType)

引数	定義
partnerName	暗号化証明書の削除対象となるパートナのID。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。

例

deleteFederationPartnerEncryptionCert(partnerName="customPartner", partnerType="idp")

deleteFederationPartnerSigningCert

パートナの署名証明書を削除します。

説明

フェデレーション・パートナの署名証明書を削除します。

構文

deleteFederationPartnerSigningCert(partnerName, partnerType)

引数	定義
partnerName	署名証明書の削除対象となるパートナのID。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。

例

deleteFederationPartnerSigningCert(partnerName="customPartner",partnerType="idp")

deleteIdPPartnerAttributeProfile

IdPパートナ属性プロファイルを削除します。

説明

IdPパートナ属性プロファイルを削除します。

構文

deleteIdPPartnerAttributeProfile(attrProfileID)

引数	定義
attrProfileID	IdPパートナ属性プロファイルを参照する識別子。

例

deleteIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")

deleteSPPartnerAttributeProfile

SPパートナ属性プロファイルを削除します。

説明

SPパートナ属性プロファイルを削除します。

構文

deleteSPPartnerAttributeProfile(attrProfileID)

引数	定義
attrProfileID	SPパートナ属性プロファイルを参照する識別子。

例

deleteSPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")

deleteIdPPartnerAttributeProfileEntry

IdPパートナ属性プロファイル・エントリを削除します。

説明

属性プロファイルから属性を削除します。

構文

deleteIdPPartnerAttributeProfileEntry(attrProfileID,
messageAttributeName)

引数	定義
attrProfileID	IdPパートナ属性プロファイルを参照する識別子。
messageAttributeName	削除する属性の名前(送信メッセージに表示される名前です)。

例

deleteIdPPartnerAttributeProfileEntry(attrProfileID="idp-attribute-profile", 
messageAttributeName="first_name")

deleteSPPartnerAttributeProfileEntry

SPパートナ属性プロファイル・エントリを削除します。

説明

属性プロファイルから属性を削除します。

構文

deleteSPPartnerAttributeProfileEntry(attrProfileID,
 messageAttributeName)

引数	定義
attrProfileID	IdPパートナ属性プロファイルを参照する識別子。
messageAttributeName	削除する属性の名前(送信メッセージに表示される名前です)。

例

deleteSPPartnerAttributeProfileEntry(attrProfileID="sp-attribute-profile", 
 messageAttributeName="first_name") 

deletePartnerProperty

パートナ・プロパティを削除します。

SAML 1.1については、「Advanced Identity Federationのコマンド」を参照してください。

説明

パートナ固有のプロパティを削除します。このコマンドは、パートナの構成に追加されたプロパティに対してのみ使用します。

構文

deletePartnerProperty(partnerName,partnerType,propName)

引数	定義
partnerName	更新するパートナのID。 <partnerName>の値をパートナIDで置換し、includecertinsignatureパラメータを含めることによって、証明書は署名に含まれます。SAML 1.1については、「Advanced Identity Federationのコマンド」を参照してください。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。
propName	削除する構成済プロパティの名前。

例

deletePartnerProperty(partnerName="partner1025", partnerType="sp/idp", propName="includecertinsignature")

displayIdPPartnerAttributeProfile

パートナ属性プロファイルを表示します。

説明

IdPパートナ属性プロファイルのコンテンツを表示します。

構文

displayIdPPartnerAttributeProfile(attrProfileID)

引数	定義
attrProfileID	表示するIdPパートナ属性プロファイルを参照する識別子。

例

displayIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")

displaySPPartnerAttributeProfile

SPパートナ属性プロファイルを表示します。

説明

SPパートナ属性プロファイルのコンテンツを表示します。

構文

displaySPPartnerAttributeProfile(attrProfileID)

引数	定義
attrProfileID	表示するSPパートナ属性プロファイルを参照する識別子。

例

displaySPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")

getAllFederationIdentityProviders

すべてのフェデレーション・アイデンティティ・プロバイダを一覧表示します。

説明

Access Managerのすべてのフェデレーション・アイデンティティ・プロバイダのリストを表示します。

構文

getAllFederationIdentityProviders()

例

getAllFederationIdentityProviders()

getAllFederationServiceProviders

すべてのフェデレーション・サービス・プロバイダを一覧表示します。

説明

Access Managerのすべてのフェデレーション・サービス・プロバイダのリストを表示します。

構文

getAllFederationServiceProviders()

例

getAllFederationServiceProviders()

getFederationPartnerEncryptionCert

パートナの暗号化証明書を取得します。

説明

フェデレーション・パートナの暗号化証明書を取得します。

構文

引数	定義
partnerName	暗号化証明書の取得対象となるパートナのID。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。

例

getFederationPartnerEncryptionCert(partnerName="customPartner",partnerType="idp")

getFederationPartnerSigningCert

パートナの署名証明書を取得します。

説明

フェデレーション・パートナの署名証明書を取得します。

構文

引数	定義
partnerName	署名証明書の取得対象となるパートナのID。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。

例

getFederationPartnerSigningCert(partnerName="partnerID1", partnerType="idp")

getIdPPartnerBasicAuthCredentialUsername

パートナの基本認証ユーザー名を取得します。

説明

フェデレーション・パートナのHTTP Basic認証ユーザー名を取得します。

構文

getIdPPartnerBasicAuthCredentialUsername(partnerName)

引数	定義
partnerName	ユーザー名の取得および表示対象となるパートナのID。

例

getIdPPartnerBasicAuthCredentialUsername(partnerName="partnerID5")

getPartnerProperty

パートナ・プロパティを取得します。

説明

フェデレーション・パートナのプロパティを取得します。

構文

getPartnerProperty(partnerName, partnerType, propName)

引数	定義
partnerName	プロパティの取得対象となるパートナのID。 <partnerName>の値をパートナIDで置換し、includecertinsignatureパラメータを含めることによって、証明書は署名に含まれます。SAML 1.1については、「Advanced Identity Federationのコマンド」を参照してください。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。有効な値は、sp、idpです。
propName	構成するプロパティの名前。

例

getPartnerProperty(partnerName="partnerID4", partnerType="sp", 
 propName="providertrusted")

getStringProperty

文字列プロパティを取得します。

説明

フェデレーション・パートナ・プロファイルの文字列プロパティを取得します。

パートナに属性プロファイルが割り当てられていない場合、(パートナがIdPかSPかに基づいて)デフォルトの属性プロファイルが使用されます。fedserverconfigファイルのdefaultattributeprofileidpおよびdefaultattributeprofilespプロパティはデフォルト・プロファイルを参照します。

構文

getStringProperty("/fedserverconfig/<propertyName>")

引数

定義

propertyName

取得するプロパティの名前。 デフォルトのパートナ・プロファイルはインストール後に使用可能で、次のプロパティがそれらのプロファイルを参照します。デフォルトのプロパティ値は、propertyNameを次のいずれかで置換することにより取得できます。 defaultpartnerprofileidpsaml20: SAML 2.0 IdPパートナのデフォルトのパートナ・プロファイル defaultpartnerprofilespsaml20: SAML 2.0 SPパートナのデフォルトのパートナ・プロファイル defaultpartnerprofileidpsaml11: SAML 1.1 IdPパートナのデフォルトのパートナ・プロファイル defaultpartnerprofilespsaml11: SAML 1.1 SPパートナのデフォルトのパートナ・プロファイル defaultpartnerprofileidpopenid20: OpenID 2.0 IdPパートナのデフォルトのパートナ・プロファイル defaultpartnerprofilespopenid20: OpenID 2.0 SPパートナのデフォルトのパートナ・プロファイル 条件: "defaultattributeprofileidp: IdPパートナのデフォルトの属性プロファイル "defaultattributeprofilesp: SPパートナのデフォルトの属性プロファイル

例

getStringProperty("/fedserverconfig/defaultpartnerprofileidpopenid20")

isFederationPartnerPresent

パートナが構成されているかどうかをチェックします。

説明

指定されたフェデレーション・パートナがAccess Manager内に定義されているかどうかをチェックします。

構文

isFederationPartnerPresent(partnerName, partnerType)

引数	定義
partnerName	パートナID。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。

例

isFederationPartnerPresent(partnerABC, SP)

listIdPPartnerAttributeProfileIDs

IdPパートナ属性プロファイルを一覧表示します。

説明

既存のIdPパートナ属性プロファイルの識別子を一覧表示します。

構文

listIdPPartnerAttributeProfileIDs()

例

listIdPPartnerAttributeProfileIDs()

listSPPartnerAttributeProfileIDs

SPパートナ属性プロファイルを一覧表示します。

説明

既存のSPパートナ属性プロファイルの識別子を一覧表示します。

構文

listSPPartnerAttributeProfileIDs()

例

listSPPartnerAttributeProfileIDs()

putStringProperty

OSTS構成で指定されたパスの下に文字列値を配置します。

説明

OSTS構成で指定されたパスの下に文字列値を配置します。

構文

putStringProperty(path="/validationtemplates/username-wss-validation-template/StringNAME",value="TestString")

引数	定義
path	文字列プロパティが配置される構成内のパス。
value	文字列。

例

putStringProperty("/spglobal/defaultssoidp", "testpartner")

setDefaultSSOIdPPartner

フェデレーテッド・シングル・サインオン(SSO)のデフォルトIdPとして機能するIdPパートナを設定します。

説明

実行時にフェデレーション認証プラグインによって設定されない場合、フェデレーテッドSSOでデフォルトIdPとして機能するIdPパートナを設定します。

構文

setDefaultSSOIdPPartner(partnerName)

引数	定義
partnerName	フェデレーテッドSSOのデフォルトIdPとして機能するパートナのID。

例

setDefaultSSOIdPPartner(partnerName="partner25")

setFederationPartnerEncryptionCert

パートナの暗号化証明書を設定します。

説明

フェデレーション・パートナの暗号化証明書を設定します。

構文

setFederationPartnerEncryptionCert(partnerName,partnerType,certFile)

引数	定義
partnerName	更新するパートナのID
partnerType	パートナ・タイプ。有効な値は、idp、spです。
certFile	暗号化証明書を格納するファイルのフルパスと名前。証明書の形式は、PEMまたはDERのいずれかです。

例

setFederationPartnerEncryptionCert
(partnerName="customPartner",partnerType="idp",
certFile="/temp/encryption_cert")

setFederationPartnerSigningCert

パートナの署名証明書を設定します。

説明

フェデレーション・パートナの署名証明書を設定します。

構文

setFederationPartnerSigningCert(partnerName,partnerType,certFile)

引数	定義
partnerName	更新するパートナのID。
partnerType	パートナ・タイプ。有効な値は、idp、spです。
certFile	署名証明書を格納するファイルのフルパスと名前を指定します。証明書の形式は、PEMまたはDERのいずれかです。

例

setFederationPartnerSigningCert
(partnerName="customPartner", partnerType="idp", 
certFile="/temp/signing_cert")

setIdPPartnerAttributeProfile

パートナ属性プロファイルを設定します。

説明

IdPパートナとのフェデレーション・シングル・サインオンの実行時に使用するIdPパートナ属性プロファイルを設定します。

構文

setIdPPartnerAttributeProfile(partnerName, attrProfileID)

引数	定義
partnerName	更新するパートナのID。
attrProfileID	設定するIdPパートナ属性プロファイルID。

例

setIdPPartnerAttributeProfile(partnerName="partnerID5", attrProfileID="idp-attribute-profile")

setIdPDefaultScheme

ユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。

説明

ユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。

構文

setIdPDefaultScheme(authnScheme, appDomain, hostID, 
 authzPolicy="ProtectedResourcePolicy")

引数	定義
authnScheme	OAM認証スキーム。
appDomain	省略可能。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。
hostID	省略可能。基底のポリシー・オブジェクトの作成時に使用するHostID。
authzPolicy	省略可能。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシーの名前。

例

setIdPDefaultScheme('LDAPScheme')

WebSphereプラットフォームで実行されている場合、コマンドにfedを追加します。

setSPPartnerAttributeProfile

SPパートナ属性プロファイルをSPパートナに設定します。

説明

SPパートナで使用するSPパートナ属性プロファイルを設定します。

構文

setSPPartnerAttributeProfile(partnerName, attrProfileID)

引数	定義
partnerName	更新するパートナのID。
attrProfileID	設定するSPパートナ属性プロファイルのID。

例

setSPPartnerAttributeProfile(partnerName="partnerID5", attrProfileID="sp-attribute-profile")

setIdPPartnerAttributeProfileEntry

IdPフェデレーション・パートナ・プロファイルを設定します。

説明

IdPパートナ属性プロファイル内のエントリを更新します。

構文

setIdPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName,
oamSessionAttributeName, requestFromIdP)

引数	定義
attrProfileID	IdPパートナ属性プロファイル。
messageAttributeName	メッセージ属性の名前。
oamSessionAttributeName	属性の名前(Access Managerセッションで表示される名前です)。
requestFromIdP	この属性をIdPパートナからリクエストする必要があるかどうかを決定します。 有効な値はtrue、falseです。

例

setIdPPartnerAttributeProfileEntry(attrProfileID="idp-attribute-profile", messageAttributeName="first_name",
oamSessionAttributeName="first_name", requestFromIdP="true")

setSPPartnerAttributeProfileEntry

SPフェデレーション・パートナ・プロファイルを設定します。

説明

SPパートナ属性プロファイル内のエントリを設定します。

構文

setSPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName,
value, alwaysSend)

引数	定義
attrProfileID	エントリを設定するSPパートナ属性プロファイルを参照する識別子。
messageAttributeName	属性の名前(送信メッセージに表示される名前です)。
value	属性要素の値。静的な文字列、ユーザー属性、セッション属性またはそれらのタイプの組合せとすることができます。
alwaysSend	この属性を常にSPパートナに送信するかどうかを指定します。有効な値はtrue、falseです。falseの場合、SPパートナがリクエストした場合のみ送信されます(OpenIDがこれをサポートしています)。

例

setSPPartnerAttributeProfileEntry(attrProfileID="sp-attribute-profile", 
 messageAttributeName="first_name", value="$user.attr.givenname", 
 alwaysSend="true")

setIdPPartnerBasicAuthCredential

パートナの基本認証資格証明を設定します。

説明

フェデレーション・パートナのHTTP Basic認証資格証明を設定または更新します。

構文

setIdPPartnerBasicAuthCredential(partnerName,username,password)

引数	定義
partnerName	更新するパートナのID。
username	ユーザーのユーザーID。
password	usernameに対応するパスワード。

例

setIdPPartnerBasicAuthCredential(partnerName="partnerID4", username="user1")

setIdPPartnerMappingAttribute

パートナのアサーション・マッピング属性を設定します。

説明

ユーザーを識別するため、IdPから受信したOpenIDアサーションからの属性が、指定されたデータ・ストア属性にマップされることを指定します。

構文

setIdPPartnerMappingAttribute(partnerName,assertionAttr,userstoreAttr)

引数	定義
partnerName	更新するパートナのID。
assertionAttr	ユーザーをアイデンティティ・ストアにマップするために使用されるアサーション内の属性名。
userstoreAttr	アサーション属性値のマップ先となる、アイデンティティ・ストア内の属性の名前。

例

setIdPPartnerMappingAttribute(partnerName="partnerID", 
assertionAttr="email", userstoreAttr="mail")

setIdPPartnerMappingAttributeQuery

ユーザーのアサーション・マッピングのパートナを属性問合せで更新します。

説明

アサーションをユーザー・ストアにマップする属性問合せを指定するパートナを設定または更新します。

構文

setIdPPartnerMappingAttributeQuery(partnerName,attrQuery)

引数	定義
partnerName	更新するパートナのID
attrQuery	使用する属性問合せ。LDAP問合せには、NameIDに加えて、SAMLアサーション内の属性を参照するプレースホルダーを含めることができます。SAMLアサーション内の属性は、その名前を%文字で囲むことで参照されます。たとえば、属性名がUserlastnameである場合、属性は%Userlastname%として参照されます。NameID値は、%fed.nameidvalue%として参照されます。

例

setIdPPartnerMappingAttributeQuery(partnerName="partnerID", 
attrQuery="(&(sn=%Userlastname%)(givenname=%Userfirstname%))")

setIdPPartnerMappingNameID

パートナのマッピングnameIDを設定します。

説明

IdPフェデレーション・パートナのアサーション・マッピングnameID値を設定します。

構文

setIdPPartnerMappingNameID(partnerName,userstoreAttr)

引数	定義
partnerName	更新するパートナのID。
userstoreAttr	アサーションnameIDのマップ先となる、アイデンティティ・ストア内の属性名。

例

setIdPPartnerMappingNameID
(partnerName="partnerID", userstoreAttr="ldapattr")

setPartnerAlias

パートナの別名を設定します。

説明

フェデレーション・パートナの別名を設定または更新します。

構文

setPartnerAlias(partnerName,partnerType,partnerAlias)

引数	定義
partnerName	更新するパートナのID。
partnerType	パートナ・タイプを指定します。有効な値は、spまたはidpです。
partnerAlias	パートナの別名。

例

setPartnerAlias(partnerName="partnerID", 
partnerType="sp", partnerAlias="tenant1")

setPartnerIDStoreAndBaseDN

パートナのアイデンティティ・ストアおよびベースDNを設定します。

説明

フェデレーション・パートナのアイデンティティ・ストアおよびベースDNを設定または更新します。

構文

setPartnerIDStoreAndBaseDN(partnerName,partnerType,storeName,searchBaseDN)

引数	定義
partnerName	更新するパートナのID。
partnerType	パートナ・タイプ。有効な値は、spまたはidpです。
storeName	アイデンティティ・ストアの名前。ブランクのままにすると、デフォルトのOAMアイデンティティ・ストアが使用されます。(省略可能)
searchBaseDN	LDAPの検索ベースDN。ブランクのままにすると、アイデンティティ・ストアで構成されている検索ベースDNが使用されます。(省略可能)

例

setPartnerIDStoreAndBaseDN(partnerName="partnerID", 
 partnerType="sp/idp", storeName="testldap",
 searchBaseDN="dc=company,dc=com")

setSPSAMLPartnerNameID

アサーションの発行中にNameIDを設定してパートナを更新します。

説明

SAMLパートナのNameIDを設定します。

構文

setSPSAMLPartnerNameID(<partnerName>, <nameIDFormat>, <nameIDValue>) 

引数	定義
partnerName	構成するパートナの名前。
nameIDFormat	使用するNameIDの形式。使用可能な値は次のとおりです。 urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressのorafed-emailaddress urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectNameのorafed-x509 urn:oasis:names:tc:SAML:2.0:nameid-format:Kerberosのorafed-kerberos urn:oasis:names:tc:SAML:2.0:nameid-format:transientのorafed-transient urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedNameのorafed-windowsnamequalifier urn:oasis:names:tc:SAML:2.0:nameid-format:persistentのorafed-persistent urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedのorafed-unspecified no NameIDのorafed-none 形式がその他の値に設定された場合、アサーションにはその値が移入されます。
nameIDValue	NameID要素の値。静的な文字列、ユーザー属性、セッション属性またはそれらのタイプの組合せとすることができます。

例

setSPSAMLPartnerNameID(partnerName="partnerID", nameIDFormat="emailAddress", 
 nameIDValue="$user.attr.mail")

updatePartnerMetadata

パートナ・メタデータを更新します。

説明

フェデレーション・パートナのメタデータを更新します。

構文

updatePartnerMetadata(partnerName,partnerType,metadataFile)

引数	定義
partnerName	更新するパートナのID
partnerType	パートナ・タイプを指定します。有効な値は、spまたはidpです。
metadataFile	メタデータ・ファイルの場所。完全なパスと名前を指定します。

例

updatePartnerMetadata(partnerName="partnerID", 
partnerType="sp", metadataFile="/common/idm/abc_metadata_file")

updatePartnerProperty

パートナ・プロパティを更新します。

SAML 1.1については、「Advanced Identity Federationのコマンド」を参照してください。

説明

フェデレーション・パートナの、指定されたプロパティを構成または更新します。

構文

updatePartnerProperty(partnerName,partnerType,propName,propValue,type)

引数	定義
partnerName	更新するパートナのID。 <partnerName>の値をパートナIDで置換し、includecertinsignatureパラメータを含めることによって、証明書は署名に含まれます。SAML 1.1については、「Advanced Identity Federationのコマンド」を参照してください。
partnerType	パートナ・タイプを指定します。有効な値は、spまたはidpです。
propName	構成するプロパティの名前。
propValue	設定するプロパティ値。
type	プロパティのデータ型。有効な値は、string、longまたはbooleanです。

例

updatePartnerProperty(partnerName="partnerID", partnerType="idp", 
propName="providertrusted",
propValue="true",type="boolean")

subjectconfirmationcheck

サブジェクト確認データ・チェックを有効または無効にします。

説明

SAMLアサーションのサブジェクト確認データ・チェックを有効または無効にします。

構文

updatePartnerProperty(partnerName,partnerType,propName,propValue,type)

引数	定義
partnerName	更新するパートナのID。
partnerType	パートナ・タイプを指定します。有効な値は、spまたはidpです。
propName	プロパティ名を'subjectconfirmationcheck'に設定します。
propValue	プロパティの値を指定します。有効な値はtrueまたはfalseです。
type	プロパティのデータ型。booleanのみを設定可能です。

例

updatePartnerProperty(partnerName="testIDP", partnerType="IDP", 
propName="subjectconfirmationcheck",
propValue="true",type="boolean")

configureFederationService

Federation ServiceのAttributeRequesterまたはAttributeResponderを有効または無効にします。

説明

Federation Serviceの機能を有効または無効にします。

構文

configureFederationService(<serviceType>,<enabled>)  

引数	定義
serviceType	値としてIDP、SP、AttributeResponderまたはAttributeRequesterを取ります。
enabled	値としてtrueまたはfalseを取ります。

例

configureFederationService("idp", "true")

configureFederationService("AttributeResponder", "true")

setFederationStore

フェデレーション・ストアでの使用を有効にして構成します。

説明

フェデレーション・レコードの格納に使用されるデータストアのjndi名を設定し、ストアをRDBMSとして設定します。

構文

setFederationStore (<enable>, <jndiname>)

引数	定義
enable	フェデレーション・データ・ストアを有効または無効にします。
jndiname	データストアのJNDI名を示します。

例

setFederationStore(enable="true", jndiname="jdbc/oamds")

configureIdPAuthnRequest

Force AuthenticationまたはIsPassive、あるいはその両方のIdPパートナまたはIdPパートナ・プロファイルを構成します。

説明

Force AuthenticationまたはIsPassive、あるいはその両方のIdPパートナまたはIdPパートナ・プロファイルを構成します。

構文

configureIdPAuthnRequest(<partner="">, <partnerProfile="">, <partnerType="">, <isPassive="false">, <forceAuthn="false">, <displayOnly="false">, <delete="false">)

引数	定義
partner	構成されるIdPパートナを示します。partnerとpartnerProfileは排他的であり、2つのうちいずれかが必須です。
partnerProfile	構成されるIdPパートナ・プロファイルを示します。partnerとpartnerProfileは排他的であり、2つのうちいずれかが必須です。
partnerType	パートナのタイプ(spまたはidp)。
isPassive	IdPパートナまたはIdPパートナ・プロファイルを構成するかどうかを示し、IdPに送信されたAuthn RequestメッセージはIdPがフェデレーションSSO中にユーザーと対話しないことを示すようにします。trueは、IdPがユーザーと対話しないことを示します。省略可能。
forceAuthn	IdPパートナまたはIdPパートナ・プロファイルを構成するかどうかを示し、IdPに送信されたAuthn Requestメッセージは、有効なセッションが存在する場合でも、ユーザーにチャレンジすることを示すようにします。trueは、ユーザーにチャレンジすることを示します。省略可能。
displayOnly	このコマンドがIs Passive設定およびForce Authn設定を表示するかどうかを示します。デフォルトはfalseです。省略可能。
delete	このコマンドが指定されたパートナまたはパートナ・プロファイルからIs Passive設定およびForce Authn設定を削除するかどうかを示します。デフォルトはfalseです。省略可能。

例

configureIdPAuthnRequest(partner="acme", isPassive="false", forceAuthn="true")

configureFedSSOAuthz

フェデレーションSSOの認可を有効にするかどうかを示すブール値。

説明

フェデレーションSSOの認可を有効または無効にします。デフォルトでは、フェデレーションSSOの認可機能は無効になります。

構文

configureFedSSOAuthz(enabled)

引数	定義
enabled	値としてtrueまたはfalseを取ります。

例

configureFedSSOAuthz("true")

configureFedDigitalSignature

デジタル署名で使用されるハッシュ・アルゴリズムの構成

説明

displayOnlyおよびdeleteパラメータがfalseの場合、このコマンドはアルゴリズムを設定します。

構文

configureFedDigitalSignature(<partner="">, 
 <partnerProfile="">, <partnerType="">, <default="false">, 
 <algorithm="SHA-256">, <displayOnly="false">, <delete="false">)

引数	定義
partner	SPパートナ・プロファイルのID。
partnerProfile	Access Managerの認証スキームがマップされるフェデレーション認証メソッド。
partnerType	フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。
default	省略可能。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。
algorithm	省略可能。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。
displayOnly	省略可能。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。
delete	省略可能。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。

例

configureFedDigitalSignature(default="true", 
 algorithm="SHA-256")

configureFedSignEncKey

デジタル署名および暗号化操作に使用する署名キー別名または暗号化キー別名、あるいはその両方を構成します。

説明

デジタル署名および暗号化操作に使用する署名キー別名または暗号化キー別名、あるいはその両方を構成します。

構文

configureFedSignEncKey(<partner="">, <partnerProfile="">, <partnerType="">, <default="false">, <signAlias="">, <encAlias="">, <displayOnly="false">, <delete="false"> 

引数	定義
partner	署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナを示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。
partnerProfile	署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナ・プロファイルを示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。
partnerType	署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナ・タイプを示します。partnerまたはpartnerProfileを指定するときに必須です。有効な値は、spまたはidpです。
default	構成するグローバル・デフォルト署名キー別名または暗号化キー別名、あるいはその両方を示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。
signAlias	署名キー別名。値を設定するときに必須です。
encAlias	暗号化キー別名。値を設定するときに必須です。
displayOnly	このコマンドが署名キー別名および暗号化キー別名を表示するかどうかを示します。デフォルトはfalseです。省略可能。
delete	このコマンドが指定されたパートナまたはパートナ・プロファイルから署名キー別名または暗号化キー別名、あるいはその両方を削除するかどうかを示します。デフォルトはfalseです。省略可能。

例

configureFedSignEncKey(default="true", signAlias="osts_signing")

configureAttributeSharingSPPartnerNameIDMapping

属性共有中に使用するNameIDからユーザー・ストア属性へのマッピングを構成します。

説明

displayOnlyがtrueの場合、コマンドはNameIDからuserstore属性へのマッピングを表示します。deleteがtrueの場合、コマンドは指定されたマッピングを削除します。それ以外の場合、有効なフラグを指定された値に設定し、nameidをuserstore属性マッピングに設定します。

構文

configureAttributeSharingSPPartnerNameIDMapping(<partner="">, 
 <partnerProfile="">, <enabled="true">, <nameidformat="">, 
 <userStoreAttribute="">, <displayOnly="false">, <delete="false">)

引数	定義
partner	構成中のパートナのID。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。
partnerProfile	マッピングを構成中のパートナ・プロファイルを示します。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。
enabled	nameIDからuserstore属性へのマッピングが有効になっているか、無効になっているかを示すブール値。省略可能。デフォルト値はtrueです。
nameidformat	userStoreAttributeにマップされるNameID形式。省略可能。削除および作成/更新操作で指定する必要があります。表示操作で指定されない場合、指定されたpartnerまたはpartnerprofileのすべてのマッピングは表示されません。許可されるNameID形式は次のとおりです。 urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressのorafed-emailaddress urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectNameのorafed-x509 urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedNameのorafed-windowsnamequalifier urn:oasis:names:tc:SAML:2.0:nameid-format:kerberosのorafed-kerberos urn:oasis:names:tc:SAML:2.0:nameid-format:transientのorafed-transient urn:oasis:names:tc:SAML:2.0:nameid-format:persistentのorafed-persistent urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedのorafed-unspecified カスタムnameid形式の<customnameidformaturi> 形式がその他の値に設定された場合、アサーションにはその値が移入されます。
userStoreAttribute	指定されたNameID形式がマップされるuserstore属性。省略可能。作成操作または更新操作に対してのみ指定する必要があります。
displayOnly	このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。省略可能。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。
delete	このコマンドがNameIDからuserstore属性へのマッピングを削除するかどうかを示します。デフォルトはfalseです。省略可能。

例

configureAttributeSharingSPPartnerNameIDMapping(partner="acme", nameidformat="orafed-emailaddress", userStoreAttribute="mail")

configureAttributeSharingSPPartnerNameIDMapping(partnerProfile="saml20-idp-partner-profile", nameidformat="orafed-emailaddress", userStoreAttribute="mail")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme", enabled="false")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme", 
 displayOnly="true")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme", 
 nameidformat="orafed-emailaddress", delete="true")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme", 
 nameidformat="orafed-emailaddress", displayOnly="true")

configureAttributeSharingIdPPartner

IdPパートナのデフォルトの属性共有nameidおよびnameid形式を構成します。

説明

IdPパートナのデフォルトの属性共有nameidおよびnameid形式を構成します。

構文

configureAttributeSharingIdPPartner(<partner="">, <partnerProfile="">,<nameidformat="">, <nameidattribute="">)

引数	定義
partner	構成中のパートナのID。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。
partnerProfile	マッピングを構成中のパートナ・プロファイルを示します。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。
nameidformat	userStoreAttributeにマップされるNameID形式。省略可能。削除および作成/更新操作で指定する必要があります。表示操作で指定されない場合、指定されたpartnerまたはpartnerprofileのすべてのマッピングは表示されません。許可されるNameID形式は次のとおりです。 urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressのorafed-emailaddress urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectNameのorafed-x509 urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedNameのorafed-windowsnamequalifier urn:oasis:names:tc:SAML:2.0:nameid-format:kerberosのorafed-kerberos urn:oasis:names:tc:SAML:2.0:nameid-format:transientのorafed-transient urn:oasis:names:tc:SAML:2.0:nameid-format:persistentのorafed-persistent urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedのorafed-unspecified カスタムnameidのorafed-custom
nameIDAttribute	nameidとして使用するuserstoreの属性。省略可能。
displayOnly	このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。省略可能。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。

例

configureAttributeSharingIdPPartner(partner="acme", 
 nameidformat="orafed-emailaddress", nameidattribute="mail")

configureAttributeSharingUserDNToIdPPartnerMapping

属性共有DNからIdPへのマッピングを構成します。

説明

displayOnlyがtrueに設定されている場合、構成が表示されます。deleteがtrueに設定されている場合、コマンドは指定されたマッピングを削除します。それ以外の場合、マッピングが作成または更新されます。

構文

configureAttributeSharingUserDNToIdPPartnerMapping(<dn="">,
 <idp="">, <displayOnly="false">, <delete="false">)  

引数	定義
dn	指定したIdPにマップするDN文字列。省略可能。マッピングを削除し、マッピングを設定するために指定する必要があります。表示操作で指定された場合、このDNのマッピングが表示されます。
idp	指定されたDNの属性オーソリティとして使用するIdPのパートナID。省略可能。マッピングを作成または更新するときのみ指定する必要があります。
displayOnly	このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。省略可能。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。
delete	このコマンドがNameIDからuserstore属性へのマッピングを削除するかどうかを示します。デフォルトはfalseです。省略可能。

例

configureAttributeSharingUserDNToIdPPartnerMapping
 (dn="dc=us,dc=oracle, dc=com", displayOnly="true")

configureAttributeSharingUserDNToIdPPartnerMapping(displayOnly="true")

configureAttributeSharingUserDNToIdPPartnerMapping(dn="dc=us,dc=oracle,dc=com", 
 delete="true")

configureAttributeSharingUserDNToIdPPartnerMapping(dn="dc=us,dc=oracle,dc=com", 
 idp="acme")

configureAttributeSharing

デフォルトの属性オーソリティを設定して属性共有機能を構成します。

説明

デフォルトの属性オーソリティを設定して属性共有機能を構成します。

構文

configureAttributeSharing(<defaultAttributeAuthority="">)  

引数	定義
defaultAttributeAuthority	デフォルトの属性オーソリティとして使用するパートナのID。このサーバーがSPモードで機能している場合のみ使用されます。

例

configureAttributeSharing(defaultAttributeAuthority="acme")

configureAttributeSharing("acme")

removeAttributeSharingFromAuthnModule

認証モジュールから属性共有プラグインを削除します。

説明

指定されたパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。

構文

removeAttributeSharingFromAuthnModule(<authnModule>, <stepName="">) 

引数	定義
authnModule	属性共有プラグインを削除するauthnModuleの名前。
stepName	削除する属性共有プラグイン・ステップのstepName。複数の属性共有ステップがある場合のみ必要です。省略可能。

例

removeAttributeSharingFromAuthnModule(authnModule="LDAPPlugin") 

removeAttributeSharingFromAuthnModule(authnModule="LDAPPlugin", 
 stepName="FedAttributeSharing")

configureAttributeSharingPlugin

特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。

説明

属性共有プラグインの入力パラメータを構成します。

構文

configureAttributeSharingPlugin(<authnModule>, <stepName=None>, 
 <nameIDVariable=None>, <idpVariable=None>, <defaultIdP=None>, 
 <nameIDFormatVariable=None>, <defaultNameIDFormat=None>, 
 <requestedAttributes=None>)  

引数	定義
authnModule	属性共有プラグインを削除するauthnModuleの名前。
stepName	削除する属性共有プラグイン・ステップのstepName。複数の属性共有ステップがある場合のみ必要です。省略可能。
nameIDVariable	ユーザーのnameIDを含むセッションまたはコンテキスト内の変数の名前。
idpVariable	属性リクエストの送信先のidp名を含むセッションまたはコンテキスト内の変数の名前。
defaultIdP	セッションまたはコンテキストからIdPを判断できない場合に、属性リクエストの送信先となるデフォルトのIdPの名前。
nameIDFormatVariable	属性リクエストで使用するnameID形式を含むセッションまたはコンテキスト内の変数の名前。
defaultNameIDFormat	セッションまたはコンテキストからnameid形式を判断できない場合に使用するデフォルトのNameID形式。許可されるNameID形式は次のとおりです。 urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressのorafed-emailaddress urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectNameのorafed-x509 urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedNameのorafed-windowsnamequalifier urn:oasis:names:tc:SAML:2.0:nameid-format:kerberosのorafed-kerberos urn:oasis:names:tc:SAML:2.0:nameid-format:transientのorafed-transient urn:oasis:names:tc:SAML:2.0:nameid-format:persistentのorafed-persistent urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedのorafed-unspecified 形式がその他の値に設定された場合、アサーションにはその値が移入されます。
requestedAttributes	IdPからリクエストする属性。この文字列はURL問合せ文字列形式です。

例

configureAttributeSharingPlugin(authnModule="LDAPPlugin", 
 nameIDVariable="dn", idpVariable="attr.idpname", defaultIdP="acme", 
 nameIDFormatVariable="attr.nameidformat", defaultNameIDFormat="orafed-x509", 
 requestedAttributes="mail&accessAllowed=allowed") 

insertAttributeSharingInToAuthnModule

属性共有ステップを認証モジュール・フローに挿入します。

説明

認証モジュール・フローから属性共有ステップを削除するのにも使用できます。

構文

insertAttributeSharingInToAuthnModule(<authnModule>, 
 <fromStep=None>, <fromCond=None>, <toStep=None>, <toCond=None>, <stepName=None>)  

引数	定義
authnModule	属性共有プラグインを挿入するauthnModuleの名前。
fromStep	その後で属性共有ステップ(または指定した名前のステップ)を挿入するステップの名前。
fromCond	fromStepの後で属性共有ステップ(または指定した名前のステップ)を呼び出す条件。OnSuccess、OnFailureまたはOnErrorのいずれかである必要があります。
toStep	属性共有ステップ(または指定した名前のステップ)の後で移動先となるステップの名前。
toCond	属性共有ステップ(または指定した名前のステップ)の後でtoStepを呼び出す条件。
stepName	フローに追加中のステップの名前。

例

insertAttributeSharingInToAuthnModule(authnModule="LDAPPlugin", 
 fromStep="stepUA", fromCond="OnSuccess")

insertAttributeSharingInToAuthnModule(authnModule="LDAPPlugin", fromStep="stepUA", 
 fromCond="OnSuccess", stepName="success")

setSPPartnerAlternateScheme

別の認証スキームでクライアントを認証する方法を提供します。

説明

アイデンティティ・フェデレーションはHTTPヘッダーを評価し、このパートナに別の認証スキームを使用するかどうか判断します。

構文

setSPPartnerAlternateScheme(<partner>, <enabled="true">, <httpHeaderName="">, 
 <httpHeaderExpression="">, <authnScheme="">, <appDomain="IAM Suite">, 
 <hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">, 
 <remove="false">)

引数	定義
partner	パートナのID。
enabled	アイデンティティ・フェデレーションがクライアントによって送信されたHTTPヘッダーを評価するかどうかを示します。
httpHeaderName	enabledがtrueの場合は必須で、評価するHTTPヘッダーです。重要: これはグローバル設定であり、すべてのパートナに影響します。
httpHeaderExpression	enabledがtrueの場合は必須で、HTTPヘッダーの値を評価するために使用される正規表現です。
authnScheme	enabledがtrueの場合は必須で、デフォルトのかわりに使用する別の認証スキームです。
appDomain	省略可能。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。
hostID	省略可能。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。
authzPolicy	省略可能。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。
remove	省略可能。trueに設定すると、パートナ構成の別のスキームのプロパティが削除されます。

注意: この操作はポリシー・オブジェクトを作成するため、アプリケーション・ドメイン(デフォルト: IAM Suite)、HostID (デフォルト: IAMSuiteAgent)および認可ポリシー(デフォルト: Protected Resource Policy)の使用を指定できますが、デフォルト値を使用することもできます。

例

この例では、アイデンティティ・フェデレーションを構成してSPパートナAcmeのパートナ・レベルで別の認証スキームを有効にします。これは、ユーザーのブラウザがiPhone文字列を含めてHTTPヘッダーUser-Agentを送信するためです。文字列はデフォルトの認証スキームではなく認証に対してBasicSchemeをトリガーします。

setSPPartnerAlternateScheme("acmeSP", "true", httpHeaderName="User-Agent", 
  httpHeaderExpression=".*iPhone.*", authnScheme="BasicScheme") 

setSPPartnerDefaultScheme

SPパートナのデフォルトの認証スキームを定義します。

説明

SPパートナのデフォルトの認証スキームを定義します。

構文

setSPPartnerDefaultScheme(<partner>, <authnScheme="">, <appDomain="IAM Suite">, 
 <hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">)

引数	定義
partner	パートナのID。
authnScheme	使用するOAM認証スキーム。
appDomain	省略可能。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。
hostID	省略可能。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。
authzPolicy	省略可能。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

setSPPartnerDefaultScheme(partnerProfile="acmeSP",
 authnScheme="BasicScheme")

setSPPartnerProfileAlternateScheme

別の認証スキームでクライアントを認証する方法を提供します。

説明

アイデンティティ・フェデレーションはHTTPヘッダーを評価し、このパートナ・プロファイルに割り当てられたパートナに別の認証スキームを使用するかどうか判断します。

構文

setSPPartnerProfileAlternateScheme(<partnerProfile>, 
 <enabled="true">, <httpHeaderName="">, <httpHeaderExpression="">, 
 <authnScheme="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">, 
 <authzPolicy="Protected Resource Policy">, <remove="false">) 

引数	定義
partnerProfile	パートナ・プロファイルのID。
enabled	アイデンティティ・フェデレーションがクライアントによって送信されたHTTPヘッダーを評価するかどうかを示します。
httpHeaderName	enabledがtrueの場合は必須で、評価するHTTPヘッダーです。重要: これはグローバル設定であり、すべてのパートナに影響します。
httpHeaderExpression	enabledがtrueの場合は必須で、HTTPヘッダーの値を評価するために使用される正規表現です。
authnScheme	enabledがtrueの場合は必須で、デフォルトのかわりに使用する別の認証スキームです。
appDomain	省略可能。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。
hostID	省略可能。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。
authzPolicy	省略可能。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

注意: この操作はポリシー・オブジェクトを作成するため、アプリケーション・ドメイン(デフォルト: IAM Suite)、HostID (デフォルト: IAMSuiteAgent)および認可ポリシー(デフォルト: Protected Resource Policy)の使用を指定できますが、デフォルト値を使用することもできます。

例

setSPPartnerProfileAlternateScheme("acmeSP", "true", 
 httpHeaderName="User-Agent", httpHeaderExpression=".*iPhone.*", 
 authnScheme="BasicScheme")

setSPPartnerProfileDefaultScheme

特定のSPパートナ・プロファイルのユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。

説明

特定のSPパートナ・プロファイルのユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。

構文

setSPPartnerProfileDefaultScheme(<partnerProfile>, 
 <authnScheme="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">, 
 <authzPolicy="Protected Resource Policy">) 

引数	定義
partnerProfile	パートナ・プロファイルのID。
authnScheme	使用するOAM認証スキーム。
appDomain	省略可能。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。
hostID	省略可能。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。
authzPolicy	省略可能。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

setSPPartnerProfileDefaultScheme("saml20-sp-partner-profile", 
 "LDAPScheme")

addSPPartnerAuthnMethod

フェデレーテッド認証メソッドと特定のSPパートナのAccess Manager認証スキームの間のマッピングを定義します。

説明

SPパートナのAccess Manager認証スキームにフェデレーテッド認証メソッドをマップします。

構文

addSPPartnerAuthnMethod(partner, authnMethod, authnScheme, 
 isDefault="true", authnLevel="-1", appDomain="IAM Suite", 
 hostID="IAMSuiteAgent", <authzPolicy="Protected Resource Policy">)

引数	定義
partner	SPパートナのID。
authnMethod	Access Managerの認証スキームがマップされるフェデレーション認証メソッド。
authnScheme	フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。
isDefault	省略可能。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。
authnLevel	省略可能。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。
appDomain	省略可能。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。
hostID	省略可能。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。
authzPolicy	省略可能。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

addSPPartnerAuthnMethod("acmeSP", 
 "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", 
 "LDAPScheme")

addSPPartnerProfileAuthnMethod

フェデレーテッド認証メソッドから特定のSPパートナ・プロファイルのAccess Manager認証スキームへのマッピングを定義します。

説明

SPパートナ・プロファイルのAccess Manager認証スキームにフェデレーテッド認証メソッドをマップします。

構文

addSPPartnerProfileAuthnMethod(partnerProfile, authnMethod, 
 authnScheme, isDefault="true", authnLevel="-1", appDomain="IAM Suite", 
 hostID="IAMSuiteAgent", <authzPolicy="Protected Resource Policy">)

引数	定義
partnerProfile	SPパートナ・プロファイルのID。
authnMethod	Access Managerの認証スキームがマップされるフェデレーション認証メソッド。
authnScheme	フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。
isDefault	省略可能。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。
authnLevel	省略可能。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。
appDomain	省略可能。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。
hostID	省略可能。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。
authzPolicy	省略可能。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

addSPPartnerProfileAuthnMethod("saml20-sp-partner-profile", 
  "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", 
  "LDAPScheme") 

addIdPPartnerAuthnMethod

特定のIdPパートナのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。

説明

このIdPパートナのユーザーが認証されるレベルを定義します。

構文

addIdPPartnerAuthnMethod(partner, authnMethod, authnLevel)  

引数	定義
partner	SPパートナ・プロファイルのID。
authnMethod	フェデレーテッド認証メソッド。
authnLevel	指定されたフェデレーテッド認証メソッドのフェデレーションSSOフロー中にAccess Managerユーザー・セッションを作成するために使用するレベル。

例

addIdPPartnerAuthnMethod("acmeIdP", 
  "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "1") 

addIdPPartnerProfileAuthnMethod

特定のIdPパートナ・プロファイルのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。

説明

このIdPパートナ・プロファイルのユーザーが認証されるレベルを定義します。

構文

addIdPPartnerProfileAuthnMethod(partnerProfile, authnMethod, 
 authnLevel)  

引数	定義
partnerProfile	SPパートナ・プロファイルのID。
authnMethod	フェデレーテッド認証メソッド。
authnLevel	指定されたフェデレーテッド認証メソッドのフェデレーションSSOフロー中にAccess Managerユーザー・セッションを作成するために使用するレベル。

例

addIdPPartnerProfileAuthnMethod("saml20-idp-partner-profile", 
  "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "1") 

listPartnerAuthnMethods

特定のパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。

説明

指定されたパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。

構文

listPartnerAuthnMethods(partner, partnerType)  

引数	定義
partner	パートナのID
partnerType	パートナのタイプ(SPまたはIdP)

例

listPartnerAuthnMethods("acmeSP", "SP") 

listPartnerProfileAuthnMethods

特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。

説明

指定されたパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。

構文

listPartnerProfileAuthnMethods(partnerProfile, partnerType)  

引数	定義
partnerProfile	パートナ・プロファイルのID
partnerType	パートナのタイプ(SPまたはIdP)

例

listPartnerProfileAuthnMethods("saml20-sp-partner-profile", "SP") 

removePartnerAuthnMethod

フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。

説明

フェデレーテッド認証メソッドと指定したパートナのAccess Manager認証スキームの間のマッピングを削除します。

構文

removePartnerAuthnMethod(<partner>, <partnerType>, <authnMethod>)  

引数	定義
partner	パートナのID
partnerType	パートナのタイプ(SPまたはIdP)
authnMethod	Access Manager認証スキーム。

例

removePartnerAuthnMethod("acmeSP", "SP",  
  "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport") 

removePartnerProfileAuthnMethod

フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。

説明

フェデレーテッド認証メソッドと指定したパートナのAccess Manager認証スキームの間のマッピングを削除します。

構文

removePartnerProfileAuthnMethod(<partnerProfile>, 
 <partnerType>, <authnMethod>)  

引数	定義
partnerProfile	パートナ・プロファイルのID
partnerType	パートナのタイプ(SPまたはIdP)
authnMethod	フェデレーテッド認証メソッド。

例

removePartnerProfileAuthnMethod("saml20-sp-partner-profile", 
"SP", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")

setIdPPartnerRequestAuthnMethod

特定のIdPパートナのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。

説明

指定したIdPパートナのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。

構文

setIdPPartnerRequestAuthnMethod(<partner>, <authnMethod>) 

引数	定義
partner	IdPパートナのID
authnMethod	フェデレーテッド認証メソッド。

例

setIdPPartnerRequestAuthnMethod("acmeIdP", 
  "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")

setIdPPartnerProfileRequestAuthnMethod

指定したIdPパートナ・プロファイルのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。

説明

指定したIdPパートナ・プロファイルのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。

構文

setIdPPartnerProfileRequestAuthnMethod(<partnerProfile>, 
 <authnMethod>)  

引数	定義
partnerProfile	IdPパートナ・プロファイルのID
authnMethod	フェデレーテッド認証メソッド。

例

setIdPPartnerProfileRequestAuthnMethod("saml20-idp-partner-profile",  
  "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")

useProxiedFedAuthnMethod

フェデレーションSSOを実行するときに、プロキシ処理されたフェデレーテッド認証メソッドを使用するアイデンティティ・プロバイダを構成します。

説明

サーバーがリモートIdPを使用してSPとして機能してユーザーを認証する場合、サーバーは別のフェデレーションSSO操作でアイデンティティ・プロバイダとして機能するときに、リモート・アイデンティティ・プロバイダによって送信されたフェデレーション認証メソッドを使用できます。サーバーは、指定したフェデレーション認証スキームの一覧に対して、プロキシ処理されたフェデレーション認証メソッドを送信します。サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するのは、サーバーとサービス・プロバイダの間で使用されるフェデレーション・プロトコルが、サーバーとアイデンティティ・プロバイダの間で使用されるのと同じフェデレーション・プロトコルである場合のみです。

構文

useProxiedFedAuthnMethod(<enabled="false">, 
 <displayOnly="false">, <authnSchemeToAdd="">, <authnSchemeToRemove="">,
 <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">, 
 <authzPolicy="Protected Resource Policy">)

引数	定義
enabled	プロキシ処理されたフェデレーション認証メソッドを使用するかどうかを示します。デフォルトでは、機能が無効になります。省略可能。
displayOnly	このコマンドが、サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するフェデレーション・スキームを一覧表示するかどうかを示します。デフォルトはfalseです。省略可能。
authnSchemeToAdd	サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するスキームの一覧に追加するOAMフェデレーション認証スキーム。authnSchemeToAddおよびauthnSchemeToRemoveパラメータは排他的です。
authnSchemeToRemove	サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するスキームの一覧から削除するOAMフェデレーション認証スキーム。authnSchemeToAddおよびauthnSchemeToRemoveパラメータは排他的です。
appDomain	基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。省略可能。
hostID	基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。省略可能。
authzPolicy	省略可能。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

useProxiedFedAuthnMethod(enabled="true", 
 authnSchemeToAdd="FederationScheme")

createFedPartnerProfileFrom

指定した既存のプロファイルに基づいてフェデレーション・パートナ・プロファイルを作成します。

説明

指定した既存のパートナ・プロファイルに基づいて新しいパートナ・プロファイルを作成します。

構文

createFedPartnerProfileFrom(<newPartnerProfile>, 
  <existingPartnerProfile>) 

引数	定義
newPartnerProfile	新しいパートナ・プロファイルのID。
existingPartnerProfile	既存のパートナ・プロファイルのID。

例

createFedPartnerProfileFrom("newAcmeSPProfile", "acmeSPProfile")

deleteFedPartnerProfile

指定したフェデレーション・パートナ・プロファイルを削除します。

説明

指定したパートナ・プロファイルを削除します。

構文

deleteFedPartnerProfile(<PartnerProfile>) 

引数	定義
PartnerProfile	削除するパートナ・プロファイルのID。

例

deleteFedPartnerProfile("acmeSPProfile")

displayFedPartnerProfile

指定したフェデレーション・パートナ・プロファイルで定義されているプロパティを表示します。

説明

指定したフェデレーション・パートナ・プロファイルのプロパティを表示します。

構文

displayFedPartnerProfile(<PartnerProfile>)

引数	定義
PartnerProfile	パートナ・プロファイルのID。

例

displayFedPartnerProfile("saml20-idp-partner-profile")

listFedPartnerProfiles

既存のすべてのフェデレーション・パートナ・プロファイルを一覧表示します。

説明

既存のフェデレーション・パートナ・プロファイルを一覧表示します。

構文

listFedPartnerProfiles()

このコマンドには、引数はありません。

例

listFedPartnerProfiles()

listFedPartnersForProfile

指定したフェデレーション・パートナ・プロファイルにバインドされたパートナを一覧表示します。

説明

指定したフェデレーション・パートナ・プロファイルにバインドされたすべてのパートナを一覧表示します。

構文

listFedPartnersForProfile(<PartnerProfile>) 

引数	定義
PartnerProfile	パートナ・プロファイルのID。

例

listFedPartnersForProfile("acmeSPProfile")

getFedPartnerProfile

指定したパートナにバインドされたパートナ・プロファイルのIDを取得します。

説明

指定したパートナにバインドされたパートナ・プロファイルのIDを取得します。

構文

getFedPartnerProfile(<partner>, <partnerType>) 

引数	定義
partner	パートナのID。
partnerType	パートナのタイプ(spまたはidp)。

例

getFedPartnerProfile("acmeIDP", "idp")

setFedPartnerProfile

指定したパートナのフェデレーション・パートナ・プロファイルのIDを設定します。

説明

指定したパートナ・プロファイルのIDに基づいて指定したパートナ・プロファイルのパートナ・プロファイルを設定します。

構文

setFedPartnerProfile(<partner>, <partnerType>, <partnerProfile>)

引数	定義
partner	パートナのID。
partnerType	パートナのタイプ(spまたはidp)。
partnerProfile	パートナ・プロファイルのID。

例

setFedPartnerProfile("acmeIDP", "idp", 
   "saml20-idp-partner-profile")

idpinitiatedssoprovideridparam

idpinitiatedssoprovideridparamによって保持される値は、SPのプロバイダIDを識別するためにピア・プロバイダによって使用されます。

説明

SPのプロバイダIDを識別するために使用する値を設定します。

構文

updatePartnerProperty(partnerName, partnerType, 
   "idpinitiatedssoprovideridparam","providerid", "string")

引数	定義
partnerName	パートナのID
partnerType	値にidpまたはspを取ります。
propName	構成または変更するプロパティの名前。
propValue	構成するプロパティの値。OIFピアIDPの場合、パラメータ名はprovideridである必要があります。このプロパティを変更すると、上記のURLで使用されているパラメータ名が変更されます。
type	プロパティ値のデータ型。有効な値は、string、longまたはbooleanです。

例

updatePartnerProperty(partnerName, "idp", 
   "idpinitiatedssoprovideridparam","providerid", "string")

idpinitiatedssotargetparam

指定したSPパートナのターゲットURLを設定します。

説明

ターゲット・リソースを識別します。idpinitiatedssotargetparamによって保持される値は、必要なリソースを識別するためにピア・プロバイダによって使用されます。Oracle Identity Federationの場合はTARGETです。

構文

updatePartnerProperty(partnerName, partnerType, 
   "idpinitiatedssotargetparam", "TARGET", "string")

引数	定義
partnerName	パートナのID
partnerType	値にidpまたはspを取ります。
propName	構成または変更するプロパティの名前。
propValue	リソースの場所。デフォルト値はTARGETです。
type	プロパティ値のデータ型。有効な値は、string、longまたはbooleanです。

例

updatePartnerProperty(partnerName, "idp", 
   "idpinitiatedssotargetparam", "TARGET", "string")

注意: 証明書をSAML 1.1署名に含めることができます。<partnerName>の値をパートナIDで置換し、includecertinsignatureパラメータを含めることによって、証明書は署名に含まれます。次に例を示します。 updatePartnerProperty("<partnerName>", "sp", "includecertinsignature", "true", "boolean") getPartnerProperty("<partnerName>", "sp", "includecertinsignature") deletePartnerProperty("<partnerName>", "sp", "includecertinsignature")