3 Identity FederationのWLSTコマンド
Identity FederationのWLSTコマンドは、2つのカテゴリに編成されています。
ノート:
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")
3.1 Identity Federationのコマンド
表3-1に示すWLSTコマンドを使用して、フェデレーション・パートナとパートナのプロファイルを構成します。
ノート:
Identity Federationのコマンドの定義は、"addWSFed11IdPFederationPartner"で開始します。
表3-1 Identity FederationのWLSTコマンド
使用するコマンド | 目的 | WLSTの使用... |
---|---|---|
WS-Fed 1.1 IdPパートナを作成します。 |
オンライン |
|
WS-Fed 1.1 SPパートナを作成します。 |
オンライン |
|
OpenID 2.0 IdPパートナを作成します。 |
オンライン |
|
OpenID 2.0 SPパートナを作成します。 |
オンライン |
|
Google OpenID 2.0 IdPパートナを作成します。 |
オンライン |
|
Yahoo OpenID 2.0 IdPパートナを作成します。 |
オンライン |
|
SAML 1.1プロトコルのもとでIdPフェデレーション・パートナを作成します(メタデータを含みます)。 |
オンライン |
|
SAML 1.1プロトコルのもとでSPフェデレーション・パートナを作成します(メタデータを含みます)。 |
オンライン |
|
SAML 2.0プロトコルのもとでIdPフェデレーション・パートナを作成します。 |
オンライン |
|
SAML 2.0プロトコルのもとでSPフェデレーション・パートナを作成します。 |
オンライン |
|
SAML 2.0プロトコルのもとで、メタデータをインポートせずにIdPフェデレーション・パートナを作成します。 |
オンライン |
|
SAML 2.0プロトコルのもとで、メタデータをインポートせずにSPフェデレーション・パートナを作成します。 |
オンライン |
|
プロファイルの一部ではない着信属性を無視するかどうかを指定するIdPパートナ属性プロファイルを構成します。 |
オンライン |
|
SAML 2.0フェデレーション・パートナのグローバル・フェデレーション・ログアウトを構成します。 |
オンライン |
|
SAMLフェデレーション・パートナの優先バインディングを構成します。 |
オンライン |
|
ユーザーの自己登録を有効にします。 |
オンライン |
|
自己登録の際に、アサーションからのどの属性を電子メール、名、姓またはユーザー名として使用する必要があるかを設定します。 |
オンライン |
|
IdPパートナの認証スキームおよびモジュールを作成します。 |
オンライン |
|
フェデレーション・パートナのIdPパートナ属性プロファイルを作成します。 |
オンライン |
|
フェデレーション・パートナのSPパートナ属性プロファイルを作成します。 |
オンライン |
|
IdPパートナの認証スキームおよびモジュールを削除します。 |
オンライン |
|
特定のフェデレーション・パートナを削除します。 |
オンライン |
|
フェデレーション・パートナの暗号化証明書を削除します。 |
オンライン |
|
フェデレーション・パートナの署名証明書を削除します。 |
オンライン |
|
IdPフェデレーション・パートナの属性プロファイルを削除します。 |
オンライン |
|
SPフェデレーション・パートナの属性プロファイルを削除します。 |
オンライン |
|
フェデレーション・パートナの属性プロファイルからエントリを削除します。 |
オンライン |
|
フェデレーション・パートナの属性プロファイルからエントリを削除します。 |
オンライン |
|
パートナの構成に追加されたパートナ固有のプロパティを削除します。 |
オンライン |
|
IdPフェデレーション・パートナの属性プロファイルを表示します。 |
オンライン |
|
SPフェデレーション・パートナの属性プロファイルを表示します。 |
オンライン |
|
すべてのIdPフェデレーション・パートナを一覧表示します。 |
オンライン |
|
フェデレーション・パートナの暗号化証明書を取得します。 |
オンライン |
|
フェデレーション・パートナの署名証明書を取得します |
オンライン |
|
フェデレーション・パートナのHTTP Basic認証ユーザー名を取得します。 |
オンライン |
|
フェデレーション・パートナのプロパティを取得します。 |
オンライン |
|
フェデレーション・パートナ・プロファイルから文字列プロパティを取得します。 |
オンライン |
|
パートナが構成されているかどうかをチェックします。 |
オンライン |
|
IdPパートナの属性プロファイルを一覧表示します。 |
オンライン |
|
SPパートナの属性プロファイルを一覧表示します。 |
オンライン |
|
デフォルトのフェデレーションIdPとしてOpenIDパートナを設定します。 |
オンライン |
|
IdPパートナを、フェデレーション・シングル・サインオンのデフォルトのアイデンティティ・プロバイダとして設定します。 |
オンライン |
|
フェデレーション・パートナの暗号化証明書を設定します。 |
オンライン |
|
フェデレーション・パートナの署名証明書を設定します。 |
オンライン |
|
IdPパートナとのフェデレーテッド・シングル・サインオンで使用する属性プロファイルを設定します。 |
オンライン |
|
デフォルトのOAM認証スキームを設定します。 |
オンライン |
|
SPパートナとのフェデレーテッド・シングル・サインオンで使用する属性プロファイルを設定します。 |
オンライン |
|
IdPフェデレーション・パートナのプロファイル内のエントリを設定します。 |
オンライン |
|
SPフェデレーション・パートナのプロファイル内のエントリを設定します。 |
オンライン |
|
setSPPartnerAttributeValueMapping | SPプロファイル内の送信属性値マッピングを追加または更新します。 |
オンライン |
deleteSPPartnerAttributeValueMapping | SPプロファイルで構成された送信属性のいずれかまたはすべての値マッピングを削除します。 |
オンライン |
displaySPPartnerAttributeValueMapping | SPプロファイルで構成されたいずれかまたはすべての送信属性の値マッピングを表示します。 |
オンライン |
setIdPPartnerAttributeValueMapping | IdPプロファイル内の着信属性値マッピングを追加または更新します。 |
オンライン |
deleteIdPPartnerAttributeValueMapping | IdPプロファイルで構成された着信属性のいずれかまたはすべての値マッピングを削除します。 |
オンライン |
displayIdPPartnerAttributeValueMapping | IdPプロファイルで構成されたいずれかまたはすべての着信属性の値マッピングを表示します。 |
オンライン |
setSPPartnerAttributeValueFilter | SPプロファイル内の属性値フィルタを追加または更新します。 |
オンライン |
deleteSPPartnerAttributeValueFilter | SPプロファイルで構成された属性のいずれかまたはすべての値フィルタを削除します。 |
オンライン |
displaySPPartnerAttributeValueFilter | SPプロファイルで構成されたいずれかまたはすべての属性の値フィルタを表示します。 |
オンライン |
フェデレーション・パートナのHTTP Basic認証資格証明を更新します。 |
オンライン |
|
フェデレーション・パートナのアサーション・マッピングに使用される属性を設定します。 |
オンライン |
|
フェデレーション・パートナのアサーション・マッピングに使用される属性問合せを設定します。 |
オンライン |
|
IdPフェデレーション・パートナのアサーション・マッピングnameID値を設定します |
オンライン |
|
フェデレーション・パートナの別名を更新します。 |
オンライン |
|
フェデレーション・パートナのアイデンティティ・ストアおよびベースDNを設定します。 |
オンライン |
|
別の認証スキームを構成します。 |
オンライン |
|
デフォルトの認証スキームを構成します。 |
オンライン |
|
デフォルトの認証スキームでプロファイルを構成します。 |
オンライン |
|
別の認証スキームでプロファイルを構成します。 |
オンライン |
|
フェデレーション・パートナのメタデータを更新します。 |
オンライン |
|
フェデレーション・パートナのプロパティを更新します。 |
オンライン |
3.1.1 addWSFed11IdPFederationPartner
addWSFed11IdPFederationPartnerコマンドはオンライン・コマンドで、WS-Federation 1.1 IdPパートナを作成します。
説明
WS-Federation 1.1プロトコルのもとでIdPパートナを作成します。NameIDは、LDAPユーザー・メール属性にマップされます。
構文
addWSFed11IdPFederationPartner(partnerName,ssoURL, providerID, description)
引数 | 定義 |
---|---|
|
作成するパートナの名前。 |
|
ユーザーがWS-Federation 1.1操作のIdPでリダイレクトされるアイデンティティ・レルム・セキュア・トークンURL。 |
|
SAMLアサーションで使用されるプロバイダID/発行者。 |
|
パートナの説明。オプション。 |
例
addWSFed11IdPFederationPartner("testpartner1", "http://idp.com/wsfed11", "http://idp.com", description="WS-Fed IdP1")
3.1.2 addWSFed11SPFederationPartner
addWSFed11SPFederationPartnerコマンドはオンライン・コマンドで、WS-Federation 1.1 SPパートナを作成します。
説明
WS-Federation 1.1プロトコルのもとでSPパートナを作成します。
構文
addWSFed11SPFederationPartner(partnerName, realm, ssoURL, samlVersion, msftADFSCompatible, description)
引数 | 定義 |
---|---|
|
作成するパートナの名前。 |
|
このSPパートナのレルム識別子。これは、WS-Federation 1.1プロトコル交換で使用されます。 |
|
ユーザーがWS-Federation 1.1操作のSPでリダイレクトされるアイデンティティ・レルム・セキュア・トークンURL。 |
|
どの種類のアサーションを発行するかを示すオプションのSAMLバージョン。値saml11 (デフォルト)またはsaml20を取ります。 |
|
発行されたSSOレスポンスを、Microsoft ADFS互換形式WS-Trust 1.2またはWS-Trust 1.3にする必要があるかどうかを示すオプションのブール値。 |
|
パートナの説明。オプション。 |
例
addWSFed11SPFederationPartner("testpartner1", "http://sp.com", "http://sp.com/wsfed11", description="Test SP1")
3.1.3 addOpenID20IdPFederationPartner
addOpenID20IdPFederationPartnerコマンドはオンライン・コマンドで、OpenID 2.0 IdPパートナを作成します。
説明
OpenID 2.0プロトコルのもとでIdPパートナを作成します。
構文
addOpenID20IdPFederationPartner(partnerName, idpSSOURL, discoveryURL, description)
引数 | 定義 |
---|---|
|
作成するパートナの名前。 |
|
IdPの起動SSO URL。検出URLを指定し、かつそれを使用する場合は、""に設定できます。 |
|
IdPのOpenID検出URL。 |
|
パートナの説明。オプション。 |
例
addOpenID20IdPFederationPartner("testpartner1", "", "http://host:port/discoveryurl", description="Test IdP1")
3.1.4 addOpenID20SPFederationPartner
addOpenID20SPFederationPartnerコマンドはオンライン・コマンドで、OpenID 2.0 SPパートナを作成します。
説明
OpenID 2.0プロトコルのもとでSPパートナを作成します。
構文
addOpenID20SPFederationPartner(partnerName, realm, ssoURL, description)
引数 | 定義 |
---|---|
|
作成するパートナの名前。 |
|
SP (RP)のレルム。 |
|
SP (RP)のエンドポイントURL。 |
|
パートナの説明。オプション。 |
例
addOpenID20SPFederationPartner(partnerName="partnerID", realm="http://realm.domain.com", ssoURL="http://host:port/endpoint", description="some description")
3.1.5 addOpenID20GoogleIdPFederationPartner
addOpenID20GoogleIdPFederationPartnerコマンドはオンライン・コマンドでIdP partnerを「google
」という名前で作成します。
説明
検出URL https://www.google.com/accounts/o8/id
を使用して、google
という名前のIdPパートナを作成します。
構文
addOpenID20GoogleIdPFederationPartner()
例
addOpenID20GoogleIdPFederationPartner()
3.1.6 addOpenID20YahooIdPFederationPartner
addOpenID20YahooIdPFederationPartnerコマンドはオンライン・コマンドで、IdPパートナを「yahoo
」という名前で作成します。
説明
検出URL https://open.login.yahooapis.com/openid20/user_profile/xrds
を使用して、yahoo
という名前のIdPパートナを作成します。
構文
addOpenID20YahooIdPFederationPartner()
例
addOpenID20YahooIdPFederationPartner()
3.1.7 addSAML11IdPFederationPartner
addSAML11IdPFederationPartnerコマンドはオンライン・コマンドで、SAML 1.1 IdPフェデレーション・パートナを作成します。
説明
SAML 1.1 IdPフェデレーション・パートナを作成します。
構文
addSAML11IdPFederationPartner(partnerName,providerID, ssoURL, soapURL, succinctID, description)
引数 | 定義 |
---|---|
|
作成するパートナの名前。 |
|
パートナのproviderID。 |
|
IdPの起動SSO URL。 |
|
IdPのアーティファクト解決SOAPエンドポイントURL。 |
|
プロバイダのsuccinctID。 |
|
パートナの説明。オプション。 |
例
addSAML11IdPFederationPartner(partnerName="partnerID", providerID="providerA", ssoURL="http://host:port/saml11sso", soapURL="http://host:port/soapurl", succinctID="1234", description="somedescription")
3.1.8 addSAML11SPFederationPartner
addSAML11SPFederationPartnerコマンドはオンライン・コマンドで、SAML 1.1 SPフェデレーション・パートナを作成します。
説明
SAML 1.1 SPフェデレーション・パートナを作成します。
構文
addSAML11SPFederationPartner(partnerName,providerID, ssoURL, description)
引数 | 定義 |
---|---|
|
作成するパートナの名前。 |
|
パートナのproviderID。 |
|
IdPの起動SSO URL。 |
|
パートナの説明。オプション。 |
例
addSAML11SPFederationPartner(partnerName="partnerID", providerID="providerA", ssoURL="http://host:port/saml11sso", description="somedescription")
3.1.9 addSAML20IdPFederationPartner
addSAML20IdPFederationPartnerコマンドはオンライン・コマンドで、SAML 2.0 IdPフェデレーション・パートナを作成します。
説明
SAML 2.0プロトコルのもとでフェデレーション・パートナをAccess Managerのアイデンティティ・プロバイダとして作成し、ファイルからパートナ・メタデータをロードします。
構文
addSAML20IdPFederationPartner(partnerName, metadataFile, description)
引数 | 定義 |
---|---|
|
作成するパートナの名前。 |
|
メタデータ・ファイルの場所(フルパス)。 |
|
パートナの説明。オプション。 |
例
addSAML20IdPFederationPartner(partnerName="partnerID", metadataFile="location_metadata_file", description="somedescription")
3.1.10 addSAML20SPFederationPartner
addSAML20SPFederationPartnerコマンドはオンライン・コマンドで、SAML 2.0 SPフェデレーション・パートナを作成します。
説明
SAML 2.0プロトコルのもとでフェデレーション・パートナをAccess Managerのサービス・プロバイダとして作成し、ファイルからパートナ・メタデータをロードします。
構文
addSAML20SPFederationPartner(partnerName, metadataFile, description)
引数 | 定義 |
---|---|
|
作成するパートナの名前。 |
|
メタデータ・ファイルの場所(フルパス)。 |
|
パートナの説明。オプション。 |
例
addSAML20SPFederationPartner(partnerName="partnerID", metadataFile="location_metadata_file", description="somedescription")
3.1.11 addSAML20IdPFederationPartnerWithoutMetadata
addSAML20IdPFederationPartnerWithoutMetadataコマンドはオンライン・コマンドで、SAML 2.0メタデータなしでSAML20 IdPフェデレーション・パートナを作成します。
説明
SAML 2.0メタデータをロードせずにSAML20 IdPフェデレーション・パートナを作成します。
構文
addSAML20IdPFederationPartnerWithoutMetadata(partnerName, providerID, ssoURL, soapURL, succinctID, description)
引数 | 定義 |
---|---|
|
作成するフェデレーション・パートナの名前。 |
|
パートナのproviderID。 |
|
IdPの起動SSO URL。 |
|
IdPのアーティファクト解決SOAPエンドポイントURL。 |
|
プロバイダのsuccinctID。 |
|
パートナの説明。オプション。 |
例
addSAML20IdPFederationPartnerWithoutMetadata(partnerName="partnerName", providerID="http://host:port", ssoURL="http://host:port/saml/sso", soapURL="http://host:port/saml/soap",description="some description")
3.1.12 addSAML20SPFederationPartnerWithoutMetadata
addSAML20SPFederationPartnerWithoutMetadataコマンドはオンライン・コマンドで、SAML 2.0メタデータなしでSAML20 SPフェデレーション・パートナを作成します。
説明
SAML 2.0メタデータをロードせずにSAML20 SPフェデレーション・パートナを作成します。
構文
addSAML20SPFederationPartnerWithoutMetadata(partnerName, providerID, ssoURL, description)
引数 | 定義 |
---|---|
|
作成するフェデレーション・パートナの名前。 |
|
パートナのproviderID。 |
|
IdPの起動SSO URL。 |
|
パートナの説明。オプション。 |
例
addSAML20SPFederationPartnerWithoutMetadata(partnerName="partnerName", providerID="http://host:port", ssoURL="http://host:port/saml/sso", description="somedescription")
3.1.13 configureIdPPartnerAttributeProfile
configureIdPPartnerAttributeProfileコマンドはオンライン・コマンドで、着信属性を処理するためのIdPパートナ属性プロファイルを構成します。
説明
プロファイル内に定義されていない着信属性を処理または無視するようにIdPパートナ属性プロファイルを構成します。
構文
configureIdPPartnerAttributeProfile(attrProfileID, ignoreUnmappedAttributes)
引数 | 定義 |
---|---|
|
構成するIdPパートナ属性プロファイルを参照する識別子。 |
|
プロファイル内に定義されていない着信属性を無視するかどうかを決定します。 有効な値は、true(無視)または(デフォルト)false(処理)です。 |
例
configureIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile", ignoreUnmappedAttributes="false")
3.1.14 configureSAML20Logout
configureSAML20Logoutコマンドはオンライン・コマンドで、SAML 2.0パートナのグローバル・フェデレーション・ログアウトを構成します。
説明
SAML 2.0フェデレーション・パートナのグローバル・フェデレーション・ログアウトを構成します。
構文
configureSAML20Logout(partnerName, partnerType, enable, saml20LogoutRequestURL, saml20LogoutResponseURL, soapURL)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるか。 有効な値は、sp、idpです。 |
|
そのパートナのグローバル・ログアウトを有効または無効にします。 有効な値は、true(有効)またはfalse(無効)です。 |
|
SAML 2.0ログアウト・リクエスト・サービスURL。 パートナがメタデータを使用して作成された場合、またはログアウトが無効な場合は、オプションです。 |
|
SAML 2.0ログアウト・レスポンス・サービスURL。 これは、パートナがメタデータを使用して作成された場合、またはログアウトが無効な場合は、オプションです。 |
|
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")
3.1.15 configureSAMLBinding
configureSAMLBindingコマンドはオンライン・コマンドで、SAMLパートナのバインディングを指定します。
説明
SAMLパートナの優先バインディングを構成します。
構文
configureSAMLBinding(partnerName, partnerType, binding, ssoResponseBinding="httppost")
引数 | 定義 |
---|---|
|
構成するパートナの名前。 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを示します。有効な値は、sp、idpです。 |
|
SSO応答以外のメッセージに使用するバインディングを指定します(認証リクエスト、ログアウト・メッセージ)。有効なオプションは、HTTP-POSTバインディングの場合はhttppost、HTTPリダイレクト・バインディングの場合はhttpredirectです。 |
|
このオプションの属性は、SSO応答に使用するバインディングを定義します。有効なオプションは、HTTP-POSTバインディングの場合はhttppost(デフォルト値)、HTTPリダイレクト・バインディングの場合はhttpredirect、アーティファクト・バインディングの場合はartifactです。 |
例
configureSAMLBinding(partnerName="partnerID", partnerType="sp", binding="httpredirect", ssoResponseBinding="httppost")
3.1.16 configureUserSelfRegistration
configureUserSelfRegistrationコマンドはオンライン・コマンドで、ユーザー自己登録モジュールを有効にします。
説明
ユーザー自己登録モジュールを有効にします。
構文
configureUserSelfRegistration(<enabled>, <registrationURL>, <regDataRetrievalAuthnEnabled>, <regDataRetrievalAuthnUsername>, <regDataRetrievalAuthnPassword>, <partnerName>)
引数 | 定義 |
---|---|
|
ユーザー自己登録モジュールが有効になっているかどうかを示します。値としてtrueまたはfalseを取ります。 |
|
自己登録のためにユーザーがリダイレクトされる場所です。partnerNameが指定されず、registrationURLが空であるか欠落している場合、現行のプロパティは変更されません。partnerNameが指定され、registrationURLが空であるか欠落している場合、このプロパティはパートナの構成から削除されます。 |
|
登録データを取得するためにサーバーに接続するときに登録ページの認証が有効になっているかどうかを示します。 |
|
サーバーから登録データを取得するときに登録ページがサーバーに送信するユーザー名を指定します。 |
|
サーバーから登録データを取得するときに登録ページがサーバーに送信するパスワードを指定します。 |
|
自己登録を有効にするIdPパートナを示します。欠落している場合、構成はグローバルに作用します。 |
例
configureUserSelfRegistration("true", regDataRetrievalAuthnEnabled="true", regDataRetrievalAuthnUsername="username", regDataRetrievalAuthnPassword="password")
3.1.17 configureUserSelfRegistrationAttr
configureUserSelfRegistrationAttrコマンドはオンライン・コマンドで、電子メール、名、姓およびユーザー名として使用されるアサーションの中の属性を設定します。
説明
アサーションの中のどの属性が電子メール、名、姓およびユーザー名として使用されるかを設定します。
構文
configureUserSelfRegistration(<registrationAttrName>, <assertionAttrNames>, <partnerName>)
引数 | 定義 |
---|---|
|
設定する自己登録ページの属性。次の値のいずれか1つを設定できます: email、firstname、lastnameまたはusername。 |
|
registrationAttrNameとして指定される自己登録ページのフィールドに移入するために使用できる、アサーションの設定可能な属性。 |
|
ユーザー自己登録を構成するIdPパートナを示します。欠落している場合、構成はグローバルに作用します。 |
例
configureUserSelfRegistrationAttr("email", "mail,fed.nameidvalue")
2番目のパラメータは、アサーションからのmailまたはfed.nameidvalueをユーザーの自己登録ページでemail属性に移入できることを示します。
3.1.18 createAuthnSchemeAndModule
createAuthnSchemeAndModuleコマンドはオンライン・コマンドで、OpenD IdPを使用する認証スキームを作成します。
説明
OpenD IdPを使用する認証スキームを作成して、Access Managerのリソースを保護します。
構文
createAuthnSchemeAndModule(partnerName)
引数 | 定義 |
---|---|
|
スキームの作成対象となるパートナの名前。 |
例
createAuthnSchemeAndModule("testpartner")
3.1.19 createIdPPartnerAttributeProfile
createIdPPartnerAttributeProfileコマンドはオンライン・コマンドで、IdP属性プロファイルを作成します。これには、着信SAMLアサーション内の属性の処理に使用される名前マッピング・ルールが含まれます。
説明
着信SAMLアサーション内の属性の処理に使用される名前マッピング・ルールを含むIdPパートナ属性プロファイルを作成します
構文
createIdPPartnerAttributeProfile(attrProfileID)
引数 | 定義 |
---|---|
|
IdP属性プロファイルの識別子。 |
例
createIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")
3.1.20 createSPPartnerAttributeProfile
createSPPartnerAttributeProfileコマンドはオンライン・コマンドで、SP属性プロファイルを作成します。これには着信SAMLアサーション内の属性の処理に使用される名前マッピング・ルールが含まれます。
説明
着信SAMLアサーション内の属性の処理に使用される名前マッピング・ルールを含むSPパートナ属性プロファイルを作成します
構文
createSPPartnerAttributeProfile(attrProfileID)
引数 | 定義 |
---|---|
|
SP属性プロファイルの識別子。 |
例
createSPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")
3.1.21 deleteAuthnSchemeAndModule
deleteAuthnSchemeAndModuleコマンドはオンライン・コマンドで、IdPパートナの認証スキームを削除します。
説明
IdPパートナの認証スキームを削除します。
構文
deleteAuthnSchemeAndModule(partnerName)
引数 | 定義 |
---|---|
|
スキームの削除対象となるパートナの名前。 |
例
deleteAuthnSchemeAndModule("testpartner")
3.1.22 deleteFederationPartner
deleteFederationPartnerコマンドはオンライン・コマンドで、Access Managerからフェデレーション・パートナを削除します。
説明
Access Managerからフェデレーション・パートナを削除します。
構文
deleteFederationPartner(partnerName, partnerType)
引数 | 定義 |
---|---|
|
削除するパートナのID。 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。 |
例
deleteFederationPartner(partnerName="partnerID", partnerType="idp")
3.1.23 deleteFederationPartnerEncryptionCert
deleteFederationPartnerEncryptionCertコマンドはオンライン・コマンドで、フェデレーション・パートナの暗号化証明書を削除します。
説明
フェデレーション・パートナの暗号化証明書を削除します。
構文
deleteFederationPartnerEncryptionCert(partnerName, partnerType)
引数 | 定義 |
---|---|
|
暗号化証明書の削除対象となるパートナのID。 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。 |
例
deleteFederationPartnerEncryptionCert(partnerName="customPartner", partnerType="idp")
3.1.24 deleteFederationPartnerSigningCert
deleteFederationPartnerSigningCertコマンドはオンライン・コマンドで、フェデレーション・パートナの署名証明書を削除します。
説明
フェデレーション・パートナの署名証明書を削除します。
構文
deleteFederationPartnerSigningCert(partnerName, partnerType)
引数 | 定義 |
---|---|
|
署名証明書の削除対象となるパートナのID。 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。 |
例
deleteFederationPartnerSigningCert(partnerName="customPartner",partnerType="idp")
3.1.25 deleteIdPPartnerAttributeProfile
deleteIdPPartnerAttributeProfileコマンドはオンライン・コマンドで、IdPパートナ属性プロファイルを削除します。
説明
IdPパートナ属性プロファイルを削除します。
構文
deleteIdPPartnerAttributeProfile(attrProfileID)
引数 | 定義 |
---|---|
|
IdPパートナ属性プロファイルを参照する識別子。 |
例
deleteIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")
3.1.26 deleteSPPartnerAttributeProfile
deleteSPPartnerAttributeProfileコマンドはオンライン・コマンドで、SPパートナ属性プロファイルを削除します。
説明
SPパートナ属性プロファイルを削除します。
構文
deleteSPPartnerAttributeProfile(attrProfileID)
引数 | 定義 |
---|---|
|
SPパートナ属性プロファイルを参照する識別子。 |
例
deleteSPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")
3.1.27 deleteIdPPartnerAttributeProfileEntry
deleteIdPPartnerAttributeProfileEntryコマンドはオンライン・コマンドで、IdPパートナ属性プロファイルからエントリを削除します。
説明
属性プロファイルから属性を削除します。
構文
deleteIdPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName)
引数 | 定義 |
---|---|
|
IdPパートナ属性プロファイルを参照する識別子。 |
|
削除する属性の名前(送信メッセージに表示される名前です)。 |
例
deleteIdPPartnerAttributeProfileEntry(attrProfileID="idp-attribute-profile", messageAttributeName="first_name")
3.1.28 deleteSPPartnerAttributeProfileEntry
deleteSPPartnerAttributeProfileEntryコマンドはオンライン・コマンドで、SPパートナ属性プロファイルからエントリを削除します。
説明
属性プロファイルから属性を削除します。
構文
deleteSPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName)
引数 | 定義 |
---|---|
|
IdPパートナ属性プロファイルを参照する識別子。 |
|
削除する属性の名前(送信メッセージに表示される名前です)。 |
例
deleteSPPartnerAttributeProfileEntry(attrProfileID="sp-attribute-profile", messageAttributeName="first_name")
3.1.29 deletePartnerProperty
deletePartnerPropertyコマンドはオンライン・コマンドで、パートナ固有のプロパティを削除します。
説明
パートナ固有のプロパティを削除します。このコマンドは、パートナの構成に追加されたプロパティに対してのみ使用します。
SAML 1.1については、「Advanced Identity Federationのコマンド」を参照してください。
構文
deletePartnerProperty(partnerName,partnerType,propName)
引数 | 定義 |
---|---|
|
更新するパートナのID。 <partnerName>の値をパートナIDで置換し、 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。 |
|
削除する構成済プロパティの名前。 |
例
deletePartnerProperty(partnerName="partner1025", partnerType="sp/idp", propName="includecertinsignature")
3.1.30 displayIdPPartnerAttributeProfile
displayIdPPartnerAttributeProfileコマンドはオンライン・コマンドで、パートナ属性プロファイルを表示します。
説明
IdPパートナ属性プロファイルのコンテンツを表示します。
構文
displayIdPPartnerAttributeProfile(attrProfileID)
引数 | 定義 |
---|---|
|
表示するIdPパートナ属性プロファイルを参照する識別子。 |
例
displayIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")
3.1.31 displaySPPartnerAttributeProfile
displaySPPartnerAttributeProfileコマンドはオンライン・コマンドで、SPパートナ属性プロファイルを表示します。
説明
SPパートナ属性プロファイルのコンテンツを表示します。
構文
displaySPPartnerAttributeProfile(attrProfileID)
引数 | 定義 |
---|---|
|
表示するSPパートナ属性プロファイルを参照する識別子。 |
例
displaySPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")
3.1.32 getAllFederationIdentityProviders
getAllFederationIdentityProvidersコマンドはオンライン・コマンドで、すべてのフェデレーション・アイデンティティ・プロバイダを一覧表示します。
説明
Access Managerのすべてのフェデレーション・アイデンティティ・プロバイダのリストを表示します。
構文
getAllFederationIdentityProviders()
例
getAllFederationIdentityProviders()
3.1.33 getAllFederationServiceProviders
getAllFederationServiceProvidersコマンドはオンライン・コマンドで、すべてのフェデレーション・サービス・プロバイダのリストを表示します。
説明
Access Managerのすべてのフェデレーション・サービス・プロバイダのリストを表示します。
構文
getAllFederationServiceProviders()
例
getAllFederationServiceProviders()
3.1.34 getFederationPartnerEncryptionCert
getFederationPartnerEncryptionCertコマンドはオンライン・コマンドで、パートナの暗号化証明書を取得します。
説明
フェデレーション・パートナの暗号化証明書を取得します。
構文
引数 | 定義 |
---|---|
|
暗号化証明書の取得対象となるパートナのID。 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。 |
例
getFederationPartnerEncryptionCert(partnerName="customPartner",partnerType="idp")
3.1.35 getFederationPartnerSigningCert
getFederationPartnerSigningCertコマンドはオンライン・コマンドで、パートナの署名証明書を取得します。
説明
フェデレーション・パートナの署名証明書を取得します。
構文
引数 | 定義 |
---|---|
|
署名証明書の取得対象となるパートナのID。 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。 |
例
getFederationPartnerSigningCert(partnerName="partnerID1", partnerType="idp")
3.1.36 getIdPPartnerBasicAuthCredentialUsername
getIdPPartnerBasicAuthCredentialUsernameコマンドはオンライン・コマンドで、パートナのBasic認証ユーザー名を取得します。
説明
フェデレーション・パートナのHTTP Basic認証ユーザー名を取得します。
構文
getIdPPartnerBasicAuthCredentialUsername(partnerName)
引数 | 定義 |
---|---|
|
ユーザー名の取得および表示対象となるパートナのID。 |
例
getIdPPartnerBasicAuthCredentialUsername(partnerName="partnerID5")
3.1.37 getPartnerProperty
getPartnerPropertyコマンドはオンライン・コマンドで、パートナ・プロパティを取得します。
説明
フェデレーション・パートナのプロパティを取得します。
構文
getPartnerProperty(partnerName, partnerType, propName)
引数 | 定義 |
---|---|
|
プロパティの取得対象となるパートナのID。 <partnerName>の値をパートナIDで置換し、 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。有効な値は、sp、idpです。 |
|
構成するプロパティの名前。 |
例
getPartnerProperty(partnerName="partnerID4", partnerType="sp", propName="providertrusted")
3.1.38 getStringProperty
getStringPropertyコマンドはオンライン・コマンドで、フェデレーション・パートナ・プロファイルの文字列プロパティを取得します。
説明
フェデレーション・パートナ・プロファイルの文字列プロパティを取得します。
パートナに属性プロファイルが割り当てられていない場合、(パートナがIdPかSPかに基づいて)デフォルトの属性プロファイルが使用されます。fedserverconfig
ファイルのdefaultattributeprofileidp
およびdefaultattributeprofilesp
プロパティはデフォルト・プロファイルを参照します。
構文
getStringProperty("/fedserverconfig/<propertyName>")
引数 | 定義 |
---|---|
|
取得するプロパティの名前。 デフォルトのパートナ・プロファイルはインストール後に使用可能で、次のプロパティがそれらのプロファイルを参照します。デフォルトのプロパティ値は、propertyNameを次のいずれかで置換することにより取得できます。
|
例
getStringProperty("/fedserverconfig/defaultpartnerprofileidpopenid20")
3.1.39 isFederationPartnerPresent
isFederationPartnerPresentコマンドはオンライン・コマンドで、パートナがAccess Manager内で構成されているかどうか確認します。
説明
指定されたフェデレーション・パートナがAccess Manager内に定義されているかどうかをチェックします。
構文
isFederationPartnerPresent(partnerName, partnerType)
引数 | 定義 |
---|---|
|
パートナID。 |
|
パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。 有効な値は、sp、idpです。 |
例
isFederationPartnerPresent(partnerABC, SP)
3.1.40 listIdPPartnerAttributeProfileIDs
listIdPPartnerAttributeProfileIDsコマンドはオンライン・コマンドで、IdPパートナ属性プロファイルを一覧表示します。
説明
既存のIdPパートナ属性プロファイルの識別子を一覧表示します。
構文
listIdPPartnerAttributeProfileIDs()
例
listIdPPartnerAttributeProfileIDs()
3.1.41 listSPPartnerAttributeProfileIDs
listSPPartnerAttributeProfileIDsコマンドはオンライン・コマンドで、SPパートナ属性プロファイルを一覧表示します。
説明
既存のSPパートナ属性プロファイルの識別子を一覧表示します。
構文
listSPPartnerAttributeProfileIDs()
例
listSPPartnerAttributeProfileIDs()
3.1.42 putStringProperty
putStringPropertyコマンドはオンライン・コマンドで、OSTS構成で指定されたパスの下に文字列値を配置します。
説明
OSTS構成で指定されたパスの下に文字列値を配置します。
構文
putStringProperty(path="/validationtemplates/username-wss-validation-template/StringNAME",value="TestString")
引数 | 定義 |
---|---|
|
文字列プロパティが配置される構成内のパス。 |
|
文字列。 |
例
putStringProperty("/spglobal/defaultssoidp", "testpartner")
3.1.43 setDefaultSSOIdPPartner
setDefaultSSOIdPPartnerコマンドはオンライン・コマンドで、IdPパートナを、フェデレーション・シングル・サインオン(SSO)のデフォルトのIdPとして機能するIdPパートナを設定します。
説明
実行時にフェデレーション認証プラグインによって設定されない場合、フェデレーテッドSSOでデフォルトIdPとして機能するIdPパートナを設定します。
構文
setDefaultSSOIdPPartner(partnerName)
引数 | 定義 |
---|---|
|
フェデレーテッドSSOのデフォルトIdPとして機能するパートナのID。 |
例
setDefaultSSOIdPPartner(partnerName="partner25")
3.1.44 setFederationPartnerEncryptionCert
setFederationPartnerEncryptionCertコマンドはオンライン・コマンドで、パートナの暗号化証明書を設定します。
説明
フェデレーション・パートナの暗号化証明書を設定します。
構文
setFederationPartnerEncryptionCert(partnerName,partnerType,certFile)
引数 | 定義 |
---|---|
|
更新するパートナのID |
|
パートナ・タイプ。有効な値は、idp、spです。 |
|
暗号化証明書を格納するファイルのフルパスと名前。証明書の形式は、PEMまたはDERのいずれかです。 |
例
setFederationPartnerEncryptionCert (partnerName="customPartner",partnerType="idp", certFile="/temp/encryption_cert")
3.1.45 setFederationPartnerSigningCert
setFederationPartnerSigningCertコマンドはオンライン・コマンドで、フェデレーション・パートナの署名証明書を設定します。
説明
フェデレーション・パートナの署名証明書を設定します。
構文
setFederationPartnerSigningCert(partnerName,partnerType,certFile)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
パートナ・タイプ。有効な値は、idp、spです。 |
|
署名証明書を格納するファイルのフルパスと名前を指定します。証明書の形式は、PEMまたはDERのいずれかです。 |
例
setFederationPartnerSigningCert (partnerName="customPartner", partnerType="idp", certFile="/temp/signing_cert")
3.1.46 setIdPPartnerAttributeProfile
setIdPPartnerAttributeProfileコマンドはオンライン・コマンドで、IdPパートナとのフェデレーション・シングル・サインオンの実行時に使用するIdPパートナ属性プロファイルを設定します。
説明
IdPパートナとのフェデレーション・シングル・サインオンの実行時に使用するIdPパートナ属性プロファイルを設定します。
構文
setIdPPartnerAttributeProfile(partnerName, attrProfileID)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
設定するIdPパートナ属性プロファイルID。 |
例
setIdPPartnerAttributeProfile(partnerName="partnerID5", attrProfileID="idp-attribute-profile")
3.1.47 setIdPDefaultScheme
setIdPDefaultSchemeコマンドはオンライン・コマンドで、ユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。
説明
ユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。
構文
setIdPDefaultScheme(authnScheme, appDomain, hostID, authzPolicy="ProtectedResourcePolicy")
引数 | 定義 |
---|---|
|
OAM認証スキーム。 |
|
オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。 |
|
オプション。基底のポリシー・オブジェクトの作成時に使用するHostID。 |
|
オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシーの名前。 |
例
setIdPDefaultScheme('LDAPScheme')
WebSphereプラットフォームで実行されている場合、コマンドにfedを追加します。
3.1.48 setSPPartnerAttributeProfile
setSPPartnerAttributeProfileコマンドはオンライン・コマンドで、SPパートナ属性プロファイルをSPパートナに設定します。
説明
SPパートナで使用するSPパートナ属性プロファイルを設定します。
構文
setSPPartnerAttributeProfile(partnerName, attrProfileID)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
設定するSPパートナ属性プロファイルのID。 |
例
setSPPartnerAttributeProfile(partnerName="partnerID5", attrProfileID="sp-attribute-profile")
3.1.49 setIdPPartnerAttributeProfileEntry
setIdPPartnerAttributeProfileEntryコマンドはオンライン・コマンドで、IdPフェデレーション・パートナ・プロファイルを設定します。
説明
IdPパートナ属性プロファイル内のエントリを更新します。
構文
setIdPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName, oamSessionAttributeName, requestFromIdP)
引数 | 定義 |
---|---|
|
IdPパートナ属性プロファイル。 |
|
メッセージ属性の名前。 |
|
属性の名前(Access Managerセッションで表示される名前です)。 |
|
この属性をIdPパートナからリクエストする必要があるかどうかを決定します。 有効な値はtrue、falseです。 |
例
setIdPPartnerAttributeProfileEntry(attrProfileID="idp-attribute-profile", messageAttributeName="first_name", oamSessionAttributeName="first_name", requestFromIdP="true")
3.1.50 setSPPartnerAttributeProfileEntry
setSPPartnerAttributeProfileEntryコマンドはオンライン・コマンドで、SPフェデレーション・パートナ・プロファイルを設定します。
説明
SPパートナ属性プロファイル内のエントリを設定します。
構文
setSPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName, value, alwaysSend)
引数 | 定義 |
---|---|
|
エントリを設定するSPパートナ属性プロファイルを参照する識別子。 |
|
属性の名前(送信メッセージに表示される名前です)。 |
|
属性要素の値。静的な文字列、ユーザー属性、セッション属性またはそれらのタイプの組合せとすることができます。 |
|
この属性を常にSPパートナに送信するかどうかを指定します。有効な値はtrue、falseです。falseの場合、SPパートナがリクエストした場合のみ送信されます(OpenIDがこれをサポートしています)。 |
例
setSPPartnerAttributeProfileEntry(attrProfileID="sp-attribute-profile", messageAttributeName="first_name", value="$user.attr.givenname", alwaysSend="true")
3.1.51 setSPPartnerAttributeValueMapping
setSPPartnerAttributeValueMappingコマンドはオンライン・コマンドで、SPプロファイル内の送信属性値マッピングを追加または更新します。
説明
SPプロファイル内の送信属性値マッピングを追加または更新します。
構文
setSPPartnerAttributeValueMapping(attrProfileID, messageAttributeName, sendUnmappedValues, localValue, externalValue, default, ignoreCase, localNull, externalNull)
引数 | 定義 |
---|---|
|
SPプロファイルのID |
|
属性名マッピングで定義されているメッセージ属性名。 |
|
オプション trueに設定すると、マッピングが定義されていない値が送信されます。この設定は、特定のマッピングではなく、属性自体に適用されます。デフォルトは、最初のマッピングについてはfalseです。後続のマッピングでは、設定されていない場合、sendUnmappedValues値は変更されません。 |
|
オプション 属性のローカル値。 デフォルトは空の文字列です。 |
|
オプション 外部メッセージで送信する対応する値。 デフォルトは空の文字列です。 |
|
オプション trueに設定すると、ローカル値を異なる外部値にマップできる場合に外部値が使用されることを示します。デフォルトをtrueに設定できるマッピングは1つのみです。 デフォルトはfalseです。 |
|
オプション trueに設定すると、属性値の照合時に文字列比較で大/小文字を区別する必要があることを示します。 デフォルトはfalseです。 |
|
オプション trueに設定すると、ローカル値がnull文字列と等しいことを示します(これは空の文字列 デフォルトはfalseです。 |
|
オプション trueに設定すると、外部値がnull文字列と等しいことを示します(これは空の文字列 デフォルトはfalseです。 |
例
setSPPartnerAttributeValueMapping(attrProfileID='idp-attribute-profile', messageAttributeName='TITLE',sendUnmappedValues='true',localValue='Doctor',externalValue='Dr',ignoreCase="true")
3.1.52 deleteSPPartnerAttributeValueMapping
deleteSPPartnerAttributeValueMappingコマンドはオンライン・コマンドで、SPプロファイルで構成された送信属性のいずれかまたはすべての値マッピングを削除します。
説明
SPプロファイルで構成された送信属性のいずれかまたはすべての値マッピングを削除します
構文
deleteSPPartnerAttributeValueMapping(attrProfileID, messageAttributeName, localValue, externalValue)
引数 | 定義 |
---|---|
|
SPプロファイルのID |
|
属性名マッピングで定義されているメッセージ属性名。 |
|
オプション 削除する必要があるマッピングのローカル値。 |
|
オプション 削除する必要があるマッピングの外部値。 |
例1
属性TITLE
のすべての値マッピングを削除するには:
deleteSPPartnerAttributeValueMapping(attrProfileID='sp-attribute-profile', messageAttributeName='TITLE')
例2
ローカル値および外部値で識別される属性TITLE
の値マッピングを削除するには:
deleteSPPartnerAttributeValueMapping(attrProfileID='sp-attribute-profile', messageAttributeName='TITLE', localValue='Doctor', externalValue='Dr')
3.1.53 displaySPPartnerAttributeValueMapping
displaySPPartnerAttributeValueMappingコマンドはオンライン・コマンドで、SPプロファイルで構成されたいずれかまたはすべての送信属性の値マッピングを表示します。
説明
SPプロファイルで構成されたいずれかまたはすべての送信属性の値マッピングを表示します。
構文
displaySPPartnerAttributeValueMapping(attrProfileID, messageAttributeName)
引数 | 定義 |
---|---|
|
SPプロファイルのID |
|
オプション 属性名マッピングで定義されているメッセージ属性名。 設定すると、指定した属性の値マッピングのみが表示されます。設定しないと、すべての属性の値マッピングが表示されます。 |
例1
すべての属性の値マッピングを表示するには:
displaySPPartnerAttributeValueMapping(attrProfileID='sp-attribute-profile')
例2
属性TITLE
の値マッピングを表示するには:
displaySPPartnerAttributeValueMapping(attrProfileID='sp-attribute-profile', messageAttributeName='TITLE')
3.1.54 setIdPPartnerAttributeValueMapping
setIdPPartnerAttributeValueMappingコマンドはオンライン・コマンドで、IdPプロファイル内の着信属性値マッピングを追加または更新します。
説明
IdPプロファイル内の着信属性値マッピングを追加または更新します。
構文
setIdPPartnerAttributeValueMapping(attrProfileID, oamSessionAttributeName, receiveUnmappedValues, receivedValue, externalValue, default, ignoreCase, receivedNull, externalNull)
引数 | 定義 |
---|---|
|
IdPプロファイルのID |
|
属性名マッピングで定義されたOAMセッション属性名。 |
|
オプション trueに設定すると、マッピングが定義されていない値が受信されます。この設定は、特定のマッピングではなく、属性自体に適用されます。 デフォルトは、最初のマッピングについてはfalseです。後続のマッピングでは、設定されていない場合、receiveUnmappedValues値は変更されません。 |
|
オプション メッセージで受信した値。 デフォルトは空の文字列です。 |
|
オプション セッションに保存される対応する値。 デフォルトは空の文字列です。 |
|
オプション trueに設定すると、受信した値を別の外部値にマップできる場合に外部値が使用されることを示します。デフォルトをtrueに設定できるマッピングは1つのみです。 デフォルトはfalseです。 |
|
オプション trueに設定すると、属性値の照合時に文字列比較で大/小文字を区別する必要があることを示します。 デフォルトはfalseです。 |
|
オプション trueに設定すると、受信した値がnull文字列と等しいことを示します(これは空の文字列 デフォルトはfalseです。 |
|
オプション trueに設定すると、外部値がnull文字列と等しいことを示します(これは空の文字列 デフォルトはfalseです。 |
例
setIdPPartnerAttributeValueMapping(attrProfileID='idp-attribute-profile', oamSessionAttributeName='title', receiveUnmappedValues='true', localValue='Doctor', externalValue='Dr', ignoreCase="true")
3.1.55 deleteIdPPartnerAttributeValueMapping
deleteIdPPartnerAttributeValueMappingコマンドはオンライン・コマンドで、IdPプロファイルで構成された着信属性のいずれかまたはすべての値マッピングを削除します。
説明
IdPプロファイルに構成された着信属性のいずれかまたはすべての値マッピングを削除します。
構文
deleteSPPartnerAttributeValueMapping(attrProfileID, oamSessionAttributeName, receivedValue, externalValue)
引数 | 定義 |
---|---|
|
IdPプロファイルのID |
|
属性名マッピングで定義されたOAMセッション属性名。 |
|
オプション 削除する必要があるマッピングの受信値。 |
|
オプション 削除する必要があるマッピングの外部値。 |
例1
属性TITLE
のすべての値マッピングを削除するには:
deleteIdPPartnerAttributeValueMapping(attrProfileID='idp-attribute-profile', oamSessionAttributeName='TITLE')
例2
受信値および外部値で識別される属性TITLE
の値マッピングを削除するには:
deleteIdPPartnerAttributeValueMapping(attrProfileID='idp-attribute-profile', oamSessionAttributeName='TITLE', receivedValue='Doctor', externalValue='Dr')
3.1.56 displayIdPPartnerAttributeValueMapping
displayIdPPartnerAttributeValueMappingコマンドはオンライン・コマンドで、IdPプロファイルで構成されたいずれかまたはすべての着信属性の値マッピングを表示します。
説明
IdPプロファイルで構成されたいずれかまたはすべての着信属性の値マッピングを表示します。
構文
displayIdPPartnerAttributeValueMapping(attrProfileID, oamSessionAttributeName)
引数 | 定義 |
---|---|
|
IdPプロファイルのID |
|
オプション 属性名マッピングで定義されたOAMセッション属性名。 設定すると、指定した属性の値マッピングのみが表示されます。設定しないと、すべての属性の値マッピングが表示されます。 |
例1
すべての属性の値マッピングを表示するには:
displayIdPPartnerAttributeValueMapping(attrProfileID='idp-attribute-profile')
例2
属性TITLE
の値マッピングを表示するには:
displayIdPPartnerAttributeValueMapping(attrProfileID='idp-attribute-profile', oamSessionAttributeName='TITLE')
3.1.57 setSPPartnerAttributeValueFilter
setSPPartnerAttributeValueFilterコマンドはオンライン・コマンドで、SPプロファイル内の属性値フィルタを追加または更新します。
説明
SPプロファイル内の属性値フィルタを追加または更新します。
構文
setSPPartnerAttributeValueFilter(attrProfileID, messageAttributeName, conditionOperator, condition, expression, ignoreCase)
引数 | 定義 |
---|---|
|
SPプロファイルのID |
|
属性名マッピングで定義されているメッセージ属性名。 |
|
オプション
この設定は、特定のマッピングではなく、属性自体に適用されます。デフォルトは、最初のフィルタについては |
|
必須 属性値の評価に使用される条件。設定できる値は次のとおりです:
デフォルトは空の文字列です。 |
|
オプション 属性値の評価に使用される値または正規表現。 デフォルトは空の文字列です。 |
|
オプション trueに設定すると、属性値の照合時に文字列比較で大/小文字を区別する必要があることを示します。 デフォルトはfalseです。 |
例
setSPPartnerAttributeValueFilter(attrProfileID='sp-attribute-profile', messageAttributeName='GROUP', conditionOperator='and', condition='contains', expression='Sale', ignoreCase="true")
3.1.58 deleteSPPartnerAttributeValueFilter
deleteSPPartnerAttributeValueFilterコマンドはオンライン・コマンドで、SPプロファイルで構成された属性のいずれかまたはすべての値フィルタを削除します。
説明
SPプロファイルで構成された属性のいずれかまたはすべての値フィルタを削除します
構文
deleteSPPartnerAttributeValueFilter(attrProfileID, attributeName, condition, expression)
引数 | 定義 |
---|---|
|
SPプロファイルのID |
|
属性名マッピングで定義されているメッセージ属性名。 |
|
オプション 削除するフィルタの条件。 特定のフィルタを削除するには、条件パラメータと式パラメータの両方の値を設定する必要があります。条件パラメータと式パラメータの両方が設定されていない場合は、属性のすべての値フィルタが削除されます。 |
|
オプション 削除するフィルタの式。 特定のフィルタを削除するには、条件パラメータと式パラメータの両方の値を設定する必要があります。条件パラメータと式パラメータの両方が設定されていない場合は、属性のすべての値フィルタが削除されます。 |
例1
属性GROUP
のすべての値フィルタを削除するには:
deleteSPPartnerAttributeValueFilter(attrProfileID='idp-attribute-profile', messageAttributeName='GROUP')
例2
条件および式の値によって識別される属性GROUP
の値フィルタを削除するには:
deleteSPPartnerAttributeValueFilter(attrProfileID='idp-attribute-profile', messageAttributeName='GROUP', condition='contains', expression='Sale')
3.1.59 displaySPPartnerAttributeValueFilter
displaySPPartnerAttributeValueFilterコマンドはオンライン・コマンドで、SPプロファイルで構成されたいずれかまたはすべての属性の値フィルタを表示します。
説明
SPプロファイルで構成されたいずれかまたはすべての属性の値フィルタを表示します。
構文
displaySPPartnerAttributeValueFilter(attrProfileID, messageAttributeName)
引数 | 定義 |
---|---|
|
SPプロファイルのID |
|
オプション 属性名マッピングで定義されているメッセージ属性名。 設定すると、指定した属性の値フィルタのみが表示されます。設定しないと、すべての属性の値フィルタが表示されます。 |
例1
すべての属性の値フィルタを表示するには:
displaySPPartnerAttributeValueFilter(attrProfileID='idp-attribute-profile')
例2
属性GROUP
の値フィルタを表示するには:
displaySPPartnerAttributeValueFilter(attrProfileID='idp-attribute-profile', messageAttributeName='GROUP')
3.1.60 setIdPPartnerBasicAuthCredential
setIdPPartnerBasicAuthCredentialコマンドはオンライン・コマンドで、パートナのBasic認証資格証明を設定します。
説明
フェデレーション・パートナのHTTP Basic認証資格証明を設定または更新します。
構文
setIdPPartnerBasicAuthCredential(partnerName,username,password)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
ユーザーのユーザーID。 |
|
usernameに対応するパスワード。 |
例
setIdPPartnerBasicAuthCredential(partnerName="partnerID4", username="user1")
3.1.61 setIdPPartnerMappingAttribute
setIdPPartnerMappingAttributeコマンドはオンライン・コマンドで、パートナのアサーション・マッピング属性を設定します。
説明
ユーザーを識別するため、IdPから受信したOpenIDアサーションからの属性が、指定されたデータ・ストア属性にマップされることを指定します。
構文
setIdPPartnerMappingAttribute(partnerName,assertionAttr,userstoreAttr)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
ユーザーをアイデンティティ・ストアにマップするために使用されるアサーション内の属性名。 |
|
アサーション属性値のマップ先となる、アイデンティティ・ストア内の属性の名前。 |
例
setIdPPartnerMappingAttribute(partnerName="partnerID", assertionAttr="email", userstoreAttr="mail")
3.1.62 setIdPPartnerMappingAttributeQuery
setIdPPartnerMappingAttributeQueryコマンドはオンライン・コマンドで、属性問合せでユーザーのアサーションをマッピングするパートナを更新します。
説明
アサーションをユーザー・ストアにマップする属性問合せを指定するパートナを設定または更新します。
構文
setIdPPartnerMappingAttributeQuery(partnerName,attrQuery)
引数 | 定義 |
---|---|
|
更新するパートナのID |
|
使用する属性問合せ。LDAP問合せには、NameIDに加えて、SAMLアサーション内の属性を参照するプレースホルダーを含めることができます。SAMLアサーション内の属性は、その名前を%文字で囲むことで参照されます。たとえば、属性名がUserlastnameである場合、属性は%Userlastname%として参照されます。NameID値は、%fed.nameidvalue%として参照されます。 |
例
setIdPPartnerMappingAttributeQuery(partnerName="partnerID", attrQuery="(&(sn=%Userlastname%)(givenname=%Userfirstname%))")
3.1.63 setIdPPartnerMappingNameID
setIdPPartnerMappingNameIDコマンドはオンライン・コマンドで、IdPフェデレーション・パートナのアサーション・マッピングnameID値を設定します。
説明
IdPフェデレーション・パートナのアサーション・マッピングnameID値を設定します。
構文
setIdPPartnerMappingNameID(partnerName,userstoreAttr)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
アサーションnameIDのマップ先となる、アイデンティティ・ストア内の属性名。 |
例
setIdPPartnerMappingNameID (partnerName="partnerID", userstoreAttr="ldapattr")
3.1.64 setPartnerAlias
setPartnerAliasコマンドはオンライン・コマンドで、フェデレーション・パートナの別名を設定します。
説明
フェデレーション・パートナの別名を設定または更新します。
構文
setPartnerAlias(partnerName,partnerType,partnerAlias)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
パートナ・タイプを指定します。有効な値は、spまたはidpです。 |
|
パートナの別名。 |
例
setPartnerAlias(partnerName="partnerID", partnerType="sp", partnerAlias="tenant1")
3.1.65 setPartnerIDStoreAndBaseDN
setPartnerIDStoreAndBaseDNコマンドはオンライン・コマンドで、フェデレーション・パートナについてパートナのアイデンティティ・ストアおよびベースDNを設定します。
説明
フェデレーション・パートナのアイデンティティ・ストアおよびベースDNを設定または更新します。
構文
setPartnerIDStoreAndBaseDN(partnerName,partnerType,storeName,searchBaseDN)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
パートナ・タイプ。有効な値は、spまたはidpです。 |
|
アイデンティティ・ストアの名前。ブランクのままにすると、デフォルトのOAMアイデンティティ・ストアが使用されます。(オプション) |
|
LDAPの検索ベースDN。ブランクのままにすると、アイデンティティ・ストアで構成されている検索ベースDNが使用されます。(オプション) |
例
setPartnerIDStoreAndBaseDN(partnerName="partnerID", partnerType="sp/idp", storeName="testldap", searchBaseDN="dc=company,dc=com")
3.1.66 setSPSAMLPartnerNameID
setSPSAMLPartnerNameIDコマンドはオンライン・コマンドで、アサーションの発行中にNameIDを設定することによってパートナを更新します。
説明
SAMLパートナのNameIDを設定します。
構文
setSPSAMLPartnerNameID(<partnerName>, <nameIDFormat>, <nameIDValue>)
引数 | 定義 |
---|---|
|
構成するパートナの名前。 |
|
使用するNameIDの形式。指定できる値は次のとおりです。
|
|
NameID要素の値。静的な文字列、ユーザー属性、セッション属性またはそれらのタイプの組合せとすることができます。 |
例
setSPSAMLPartnerNameID(partnerName="partnerID", nameIDFormat="emailAddress", nameIDValue="$user.attr.mail")
3.1.67 setSPPartnerAlternateScheme
setSPPartnerAlternateSchemeコマンドはオンライン・コマンドで、別の認証スキームでクライアントを認証する方法を提供します。
説明
Identity FederationはHTTPヘッダーを評価し、このパートナに別の認証スキームを使用するかどうか判断します。
構文
setSPPartnerAlternateScheme(<partner>, <enabled="true">, <httpHeaderName="">, <httpHeaderExpression="">, <authnScheme="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">, <remove="false">)
引数 | 定義 |
---|---|
|
パートナのID。 |
|
Identity Federationがクライアントによって送信されたHTTPヘッダーを評価するかどうかを示します |
|
enabledがtrueの場合は必須で、評価するHTTPヘッダーです。重要: これはグローバル設定であり、すべてのパートナに影響します。 |
|
enabledがtrueの場合は必須で、HTTPヘッダーの値を評価するために使用される正規表現です。 |
|
enabledがtrueの場合は必須で、デフォルトのかわりに使用する別の認証スキームです。 |
|
オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。 |
|
オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。 |
|
オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。 |
|
オプション。trueに設定すると、パートナ構成の別のスキームのプロパティが削除されます。 |
ノート:
この操作はポリシー・オブジェクトを作成するため、アプリケーション・ドメイン(デフォルト: IAM Suite)、HostID (デフォルト: IAMSuiteAgent)および認可ポリシー(デフォルト: Protected Resource Policy)の使用を指定できますが、デフォルト値を使用することもできます。
例
この例では、Identity Federationを構成してSPパートナAcmeのパートナ・レベルで別の認証スキームを有効にします。これは、ユーザーのブラウザがiPhone文字列を含めてHTTPヘッダーUser-Agentを送信するためです。文字列はデフォルトの認証スキームではなく認証に対してBasicSchemeをトリガーします。
setSPPartnerAlternateScheme("acmeSP", "true", httpHeaderName="User-Agent", httpHeaderExpression=".*iPhone.*", authnScheme="BasicScheme")
3.1.68 setSPPartnerDefaultScheme
setSPPartnerDefaultSchemeコマンドはオンライン・コマンドで、SPパートナのデフォルトの認証スキームを定義します。
説明
SPパートナのデフォルトの認証スキームを定義します。
構文
setSPPartnerDefaultScheme(<partner>, <authnScheme="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">)
引数 | 定義 |
---|---|
|
パートナのID。 |
|
使用するOAM認証スキーム。 |
|
オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。 |
|
オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。 |
|
オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。 |
例
setSPPartnerDefaultScheme(partnerProfile="acmeSP", authnScheme="BasicScheme")
3.1.69 setSPPartnerProfileAlternateScheme
setSPPartnerProfileAlternateSchemeコマンドはオンライン・コマンドで、別の認証スキームでクライアントを認証する方法を提供します。
説明
Identity FederationはHTTPヘッダーを評価し、このパートナ・プロファイルに割り当てられたパートナに別の認証スキームを使用するかどうか判断します。
構文
setSPPartnerProfileAlternateScheme(<partnerProfile>, <enabled="true">, <httpHeaderName="">, <httpHeaderExpression="">, <authnScheme="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">, <remove="false">)
引数 | 定義 |
---|---|
|
パートナ・プロファイルのID。 |
|
Identity Federationがクライアントによって送信されたHTTPヘッダーを評価するかどうかを示します |
|
enabledがtrueの場合は必須で、評価するHTTPヘッダーです。重要: これはグローバル設定であり、すべてのパートナに影響します。 |
|
enabledがtrueの場合は必須で、HTTPヘッダーの値を評価するために使用される正規表現です。 |
|
enabledがtrueの場合は必須で、デフォルトのかわりに使用する別の認証スキームです。 |
|
オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。 |
|
オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。 |
|
オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。 |
ノート:
この操作はポリシー・オブジェクトを作成するため、アプリケーション・ドメイン(デフォルト: IAM Suite)、HostID (デフォルト: IAMSuiteAgent)および認可ポリシー(デフォルト: Protected Resource Policy)の使用を指定できますが、デフォルト値を使用することもできます。
例
setSPPartnerProfileAlternateScheme("acmeSP", "true", httpHeaderName="User-Agent", httpHeaderExpression=".*iPhone.*", authnScheme="BasicScheme")
3.1.70 setSPPartnerProfileDefaultScheme
setSPPartnerProfileDefaultSchemeコマンドはオンライン・コマンドで、特定のSPパートナ・プロファイルのユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。
説明
特定のSPパートナ・プロファイルのユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。
構文
setSPPartnerProfileDefaultScheme(<partnerProfile>, <authnScheme="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">)
引数 | 定義 |
---|---|
|
パートナ・プロファイルのID。 |
|
使用するOAM認証スキーム。 |
|
オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。 |
|
オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。 |
|
オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。 |
例
setSPPartnerProfileDefaultScheme("saml20-sp-partner-profile", "LDAPScheme")
3.1.71 updatePartnerMetadata
updatePartnerMetadataコマンドはオンライン・コマンドで、フェデレーション・パートナのメタデータを更新します。
説明
フェデレーション・パートナのメタデータを更新します。
構文
updatePartnerMetadata(partnerName,partnerType,metadataFile)
引数 | 定義 |
---|---|
|
更新するパートナのID |
|
パートナ・タイプを指定します。有効な値は、spまたはidpです。 |
|
メタデータ・ファイルの場所。完全なパスと名前を指定します。 |
例
updatePartnerMetadata(partnerName="partnerID", partnerType="sp", metadataFile="/common/idm/abc_metadata_file")
3.1.72 updatePartnerProperty
updatePartnerPropertyコマンドはオンライン・コマンドで、パートナ・プロパティを更新します。
説明
フェデレーション・パートナの、指定されたプロパティを構成または更新します。
SAML 1.1については、「Advanced Identity Federationのコマンド」を参照してください。
構文
updatePartnerProperty(partnerName,partnerType,propName,propValue,type)
引数 | 定義 |
---|---|
|
更新するパートナのID。 <partnerName>の値をパートナIDで置換し、 |
|
パートナ・タイプを指定します。有効な値は、spまたはidpです。 |
|
構成するプロパティの名前。 |
|
設定するプロパティ値。 |
|
プロパティのデータ型。有効な値は、string、longまたはbooleanです。 |
例
updatePartnerProperty(partnerName="partnerID", partnerType="idp", propName="providertrusted", propValue="true",type="boolean")
3.2 Advanced Identity Federationのコマンド
Advanced Identity FederationのWLSTコマンドには、Access Managementコンソールの構成で該当する管理フィールドがありません。認証マッピングの管理とパートナ・プロファイルはWLSTコマンドを使用してのみ利用できます。表3-2に、この項に記載するAdvanced Identity Federationのコマンドを示します。コマンドは次のように編成されています。
-
フェデレーション・サービスとデータストア
-
フェデレーション・アクセスの構成
-
属性共有の構成
-
認証メソッド・マッピング管理 - すべての認証メソッド/スキーマ/レベルのマッピングは、パートナ・レベル、あるいはパートナ・レベルで定義されない場合はパートナ・プロファイル・レベルでWLSTを使用して構成されます。
-
パートナ・プロファイル管理 - すべてのパートナ・プロファイル管理はWLSTを使用して行います。
-
WLSTとSAML 1.1の使用
ノート:
Advanced Identity Federationのコマンドの定義は、"configureFederationService"で開始します。
表3-2 Advanced Identity FederationのWLSTコマンド
使用するコマンド | 目的 | WLSTの使用... |
---|---|---|
フェデレーション・サービスとデータストア |
||
Federation Serviceの機能を有効または無効にします。 |
||
フェデレーション・ストアを有効にして構成します。 |
||
フェデレーション・アクセスの構成 |
||
Force AuthenticationまたはIsPassive、あるいはその両方のIdPパートナまたはIdPパートナ・プロファイルを構成します。 |
||
フェデレーションSSOの認可を有効または無効にします。 |
||
デジタル署名で使用されるハッシュ・アルゴリズムの構成 |
||
デジタル署名および暗号化操作に使用する署名キー別名または暗号化キー別名、あるいはその両方を構成します。 |
||
属性共有の構成 |
||
属性共有中に使用するNameIDからユーザー・ストア属性へのマッピングを構成します。 |
||
IdPパートナのデフォルトの属性共有nameidおよびnameid形式を構成します。 |
||
属性共有DNからIdPへのマッピングを構成します。 |
||
デフォルトの属性オーソリティを設定して属性共有機能を構成します。 |
||
認証モジュールから属性共有プラグインを削除します。 |
||
特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。 |
||
属性共有ステップを認証モジュール・フローに挿入します。 |
||
認証メソッド・マッピング管理 |
||
別の認証スキーム(パートナ)でクライアントを認証する方法を提供します。 |
||
SPパートナのデフォルトの認証スキームを定義します。 |
||
別の認証スキーム(パートナ・プロファイル)でクライアントを認証する方法を提供します。 |
||
特定のSPパートナ・プロファイルのユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。 |
||
フェデレーテッド認証メソッドと特定のSPパートナのAccess Manager認証スキームの間のマッピングを定義します。 |
||
フェデレーテッド認証メソッドから特定のSPパートナ・プロファイルのAccess Manager認証スキームへのマッピングを定義します。 |
||
特定のIdPパートナのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。 |
||
特定のIdPパートナ・プロファイルのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。 |
||
特定のパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。 |
||
特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。 |
||
フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。 |
||
フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。 |
||
特定のIdPパートナのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。 |
||
指定したIdPパートナ・プロファイルのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。 |
||
フェデレーションSSOを実行するときに、プロキシ処理されたフェデレーテッド認証メソッドを使用するアイデンティティ・プロバイダを構成します。 |
||
パートナ・プロファイル管理 |
||
指定した既存のプロファイルに基づいてフェデレーション・パートナ・プロファイルを作成します。 |
||
指定したフェデレーション・パートナ・プロファイルを削除します。 |
||
指定したフェデレーション・パートナ・プロファイルで定義されているプロパティを表示します。 |
||
既存のすべてのフェデレーション・パートナ・プロファイルを一覧表示します。 |
||
指定したフェデレーション・パートナ・プロファイルにバインドされたパートナを一覧表示します。 |
||
指定したパートナにバインドされたパートナ・プロファイルのIDを取得します。 |
||
指定したパートナのフェデレーション・パートナ・プロファイルのIDを設定します。 |
SAML 1.1でのWLSTの使用
IDPパートナがSAML 1.1に対して構成されている場合、SSOプロセスを開始するために次のURLがSPによって使用されます。
http://idphost:idpport/ssourl?TARGET=targeturl&providerid=http://spproviderid
これらのWLSTコマンドを使用することで、URLに該当する情報を移入できます。
使用するコマンド | 目的 | WLSTの使用... |
---|---|---|
値は、SPのプロバイダIDを識別するためにピア・プロバイダが使用します。 |
||
指定したSPパートナのターゲットURLを設定します。 |
次のSAML 1.1構成パラメータは、Oracle Access Managementコンソールからは公開されません。これらのパラメータの値は、WLSTを使用して変更できます。
使用するコマンド | 目的 | WLSTの使用... |
---|---|---|
パートナ・プロパティを削除します。 |
||
パートナ・プロパティを取得します。 |
||
パートナ・プロパティを更新します。 |
||
サブジェクト確認チェック |
||
SAMLアサーションのサブジェクト確認データ・チェックを有効または無効にします。 |
3.2.1 configureFederationService
configureFederationServiceコマンドは、Federation ServiceのAttributeRequesterまたはAttributeResponderを有効または無効にします。
説明
Federation Serviceの機能を有効または無効にします。
構文
configureFederationService(<serviceType>,<enabled>)
引数 | 定義 |
---|---|
|
値としてIDP、SP、AttributeResponderまたはAttributeRequesterを取ります。 |
|
値としてtrueまたはfalseを取ります。 |
例
configureFederationService("idp", "true") configureFederationService("AttributeResponder", "true")
3.2.2 setFederationStore
setFederationStoreコマンドは、フェデレーション・ストアの使用を有効にし、構成します。
説明
フェデレーション・レコードの格納に使用されるデータストアのjndi名を設定し、ストアをRDBMSとして設定します。
構文
setFederationStore (<enable>, <jndiname>)
引数 | 定義 |
---|---|
|
フェデレーション・データ・ストアを有効または無効にします。 |
|
データストアのJNDI名を示します。 |
例
setFederationStore(enable="true", jndiname="jdbc/oamds")
3.2.3 configureIdPAuthnRequest
configureIdPAuthnRequestコマンドは、Force AuthenticationまたはIsPassive、あるいはその両方のIdPパートナまたはIdPパートナ・プロファイルを構成します。
説明
Force AuthenticationまたはIsPassive、あるいはその両方のIdPパートナまたはIdPパートナ・プロファイルを構成します。
構文
configureIdPAuthnRequest(<partner="">, <partnerProfile="">, <partnerType="">, <isPassive="false">, <forceAuthn="false">, <displayOnly="false">, <delete="false">)
引数 | 定義 |
---|---|
|
構成されるIdPパートナを示します。partnerとpartnerProfileは排他的であり、2つのうちいずれかが必須です。 |
|
構成されるIdPパートナ・プロファイルを示します。partnerとpartnerProfileは排他的であり、2つのうちいずれかが必須です。 |
|
パートナのタイプ(spまたはidp)。 |
|
IdPパートナまたはIdPパートナ・プロファイルを構成するかどうかを示し、IdPに送信されたAuthn RequestメッセージはIdPがフェデレーションSSO中にユーザーと対話しないことを示すようにします。trueは、IdPがユーザーと対話しないことを示します。オプション。 |
|
IdPパートナまたはIdPパートナ・プロファイルを構成するかどうかを示し、IdPに送信されたAuthn Requestメッセージは、有効なセッションが存在する場合でも、ユーザーにチャレンジすることを示すようにします。trueは、ユーザーにチャレンジすることを示します。オプション。 |
|
このコマンドがIs Passive設定およびForce Authn設定を表示するかどうかを示します。デフォルトはfalseです。オプション。 |
|
このコマンドが指定されたパートナまたはパートナ・プロファイルからIs Passive設定およびForce Authn設定を削除するかどうかを示します。デフォルトはfalseです。オプション。 |
例
configureIdPAuthnRequest(partner="acme", isPassive="false", forceAuthn="true")
3.2.4 configureFedSSOAuthz
configureFedSSOAuthzコマンドは、フェデレーションSSOの認可を有効または無効にします。
説明
フェデレーションSSOの認可を有効または無効にします。デフォルトでは、フェデレーションSSOの認可機能は無効になります。
構文
configureFedSSOAuthz(enabled)
引数 | 定義 |
---|---|
|
値としてtrueまたはfalseを取ります。 |
例
configureFedSSOAuthz("true")
3.2.5 configureFedDigitalSignature
configureFedDigitalSignatureコマンドは、デジタル署名で使用されるハッシュ・アルゴリズムを構成します。
説明
displayOnlyおよびdeleteパラメータがfalseの場合、このコマンドはアルゴリズムを設定します。
構文
configureFedDigitalSignature(<partner="">, <partnerProfile="">, <partnerType="">, <default="false">, <algorithm="SHA-256">, <displayOnly="false">, <delete="false">)
引数 | 定義 |
---|---|
|
SPパートナ・プロファイルのID。 |
|
Access Managerの認証スキームがマップされるフェデレーション認証メソッド。 |
|
フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。 |
|
オプション。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。 |
|
オプション。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。 |
|
オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。 |
|
オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。 |
例
configureFedDigitalSignature(default="true", algorithm="SHA-256")
3.2.6 configureFedSignEncKey
configureFedSignEncKeyコマンドは、デジタル署名および暗号化操作に使用する署名キー別名または暗号化キー別名、あるいはその両方を構成します。
説明
デジタル署名および暗号化操作に使用する署名キー別名または暗号化キー別名、あるいはその両方を構成します。
構文
configureFedSignEncKey(<partner="">, <partnerProfile="">, <partnerType="">, <default="false">, <signAlias="">, <encAlias="">, <displayOnly="false">, <delete="false">
引数 | 定義 |
---|---|
|
署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナを示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。 |
|
署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナ・プロファイルを示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。 |
|
署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナ・タイプを示します。partnerまたはpartnerProfileを指定するときに必須です。有効な値は、spまたはidpです。 |
|
構成するグローバル・デフォルト署名キー別名または暗号化キー別名、あるいはその両方を示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。 |
|
署名キー別名。値を設定するときに必須です。 |
|
暗号化キー別名。値を設定するときに必須です。 |
|
このコマンドが署名キー別名および暗号化キー別名を表示するかどうかを示します。デフォルトはfalseです。オプション。 |
|
このコマンドが指定されたパートナまたはパートナ・プロファイルから署名キー別名または暗号化キー別名、あるいはその両方を削除するかどうかを示します。デフォルトはfalseです。オプション。 |
例
configureFedSignEncKey(default="true", signAlias="osts_signing")
3.2.7 configureAttributeSharingSPPartnerNameIDMapping
configureAttributeSharingSPPartnerNameIDMappingコマンドは、属性共有中に使用するNameIDからユーザー・ストア属性へのマッピングを構成します。
説明
displayOnlyがtrueの場合、コマンドはNameIDからuserstore属性へのマッピングを表示します。deleteがtrueの場合、コマンドは指定されたマッピングを削除します。それ以外の場合、有効なフラグを指定された値に設定し、nameidをuserstore属性マッピングに設定します。
構文
configureAttributeSharingSPPartnerNameIDMapping(<partner="">, <partnerProfile="">, <enabled="true">, <nameidformat="">, <userStoreAttribute="">, <displayOnly="false">, <delete="false">)
引数 | 定義 |
---|---|
|
構成中のパートナのID。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。 |
|
マッピングを構成中のパートナ・プロファイルを示します。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。 |
|
nameIDからuserstore属性へのマッピングが有効になっているか、無効になっているかを示すブール値。オプション。デフォルト値はtrueです。 |
|
userStoreAttributeにマップされるNameID形式。オプション。削除および作成/更新操作で指定する必要があります。表示操作で指定されない場合、指定されたpartnerまたはpartnerprofileのすべてのマッピングは表示されません。許可されるNameID形式は次のとおりです。
形式がその他の値に設定された場合、アサーションにはその値が移入されます。 |
|
指定されたNameID形式がマップされるuserstore属性。オプション。作成操作または更新操作に対してのみ指定する必要があります。 |
|
このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。オプション。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。 |
|
このコマンドが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")
3.2.8 configureAttributeSharingIdPPartner
configureAttributeSharingIdPPartnerコマンドは、IdPパートナのデフォルトの属性共有nameidおよびnameid形式を構成します。
説明
IdPパートナのデフォルトの属性共有nameidおよびnameid形式を構成します。
構文
configureAttributeSharingIdPPartner(<partner="">, <partnerProfile="">,<nameidformat="">, <nameidattribute="">)
引数 | 定義 |
---|---|
|
構成中のパートナのID。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。 |
|
マッピングを構成中のパートナ・プロファイルを示します。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。 |
|
userStoreAttributeにマップされるNameID形式。オプション。削除および作成/更新操作で指定する必要があります。表示操作で指定されない場合、指定されたpartnerまたはpartnerprofileのすべてのマッピングは表示されません。許可されるNameID形式は次のとおりです。
|
|
nameidとして使用するuserstoreの属性。オプション。 |
|
このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。オプション。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。 |
例
configureAttributeSharingIdPPartner(partner="acme", nameidformat="orafed-emailaddress", nameidattribute="mail")
3.2.9 configureAttributeSharingUserDNToIdPPartnerMapping
configureAttributeSharingUserDNToIdPPartnerMappingコマンドは、属性共有DNからIdPへのマッピングを構成します。
説明
displayOnlyがtrueに設定されている場合、構成が表示されます。deleteがtrueに設定されている場合、コマンドは指定されたマッピングを削除します。それ以外の場合、マッピングが作成または更新されます。
構文
configureAttributeSharingUserDNToIdPPartnerMapping(<dn="">, <idp="">, <displayOnly="false">, <delete="false">)
引数 | 定義 |
---|---|
|
指定したIdPにマップするDN文字列。オプション。マッピングを削除し、マッピングを設定するために指定する必要があります。表示操作で指定された場合、このDNのマッピングが表示されます。 |
|
指定されたDNの属性オーソリティとして使用するIdPのパートナID。オプション。マッピングを作成または更新するときのみ指定する必要があります。 |
|
このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。オプション。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。 |
|
このコマンドが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")
3.2.10 configureAttributeSharing
configureAttributeSharingコマンドは、デフォルトの属性オーソリティを設定して属性共有機能を構成します。
説明
デフォルトの属性オーソリティを設定して属性共有機能を構成します。
構文
configureAttributeSharing(<defaultAttributeAuthority="">)
引数 | 定義 |
---|---|
|
デフォルトの属性オーソリティとして使用するパートナのID。このサーバーがSPモードで機能している場合のみ使用されます。 |
例
configureAttributeSharing(defaultAttributeAuthority="acme") configureAttributeSharing("acme")
3.2.11 removeAttributeSharingFromAuthnModule
removeAttributeSharingFromAuthnModuleコマンドは、認証モジュールから属性共有プラグインを削除します。
説明
指定されたパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。
構文
removeAttributeSharingFromAuthnModule(<authnModule>, <stepName="">)
引数 | 定義 |
---|---|
|
属性共有プラグインを削除するauthnModuleの名前。 |
|
削除する属性共有プラグイン・ステップのstepName。複数の属性共有ステップがある場合のみ必要です。オプション。 |
例
removeAttributeSharingFromAuthnModule(authnModule="LDAPPlugin") removeAttributeSharingFromAuthnModule(authnModule="LDAPPlugin", stepName="FedAttributeSharing")
3.2.12 configureAttributeSharingPlugin
configureAttributeSharingPluginコマンドは、特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。
説明
属性共有プラグインの入力パラメータを構成します。
構文
configureAttributeSharingPlugin(<authnModule>, <stepName=None>, <nameIDVariable=None>, <idpVariable=None>, <defaultIdP=None>, <nameIDFormatVariable=None>, <defaultNameIDFormat=None>, <requestedAttributes=None>)
引数 | 定義 |
---|---|
|
属性共有プラグインを削除するauthnModuleの名前。 |
|
削除する属性共有プラグイン・ステップのstepName。複数の属性共有ステップがある場合のみ必要です。オプション。 |
|
ユーザーのnameIDを含むセッションまたはコンテキスト内の変数の名前。 |
|
属性リクエストの送信先のidp名を含むセッションまたはコンテキスト内の変数の名前。 |
|
セッションまたはコンテキストからIdPを判断できない場合に、属性リクエストの送信先となるデフォルトのIdPの名前。 |
|
属性リクエストで使用するnameID形式を含むセッションまたはコンテキスト内の変数の名前。 |
|
セッションまたはコンテキストからnameid形式を判断できない場合に使用するデフォルトのNameID形式。許可されるNameID形式は次のとおりです。
形式がその他の値に設定された場合、アサーションにはその値が移入されます。 |
|
IdPからリクエストする属性。この文字列はURL問合せ文字列形式です。 |
例
configureAttributeSharingPlugin(authnModule="LDAPPlugin", nameIDVariable="dn", idpVariable="attr.idpname", defaultIdP="acme", nameIDFormatVariable="attr.nameidformat", defaultNameIDFormat="orafed-x509", requestedAttributes="mail&accessAllowed=allowed")
3.2.13 insertAttributeSharingInToAuthnModule
insertAttributeSharingInToAuthnModuleコマンドは、属性共有ステップを認証モジュール・フローに挿入します。
説明
認証モジュール・フローから属性共有ステップを削除するのにも使用できます。
構文
insertAttributeSharingInToAuthnModule(<authnModule>, <fromStep=None>, <fromCond=None>, <toStep=None>, <toCond=None>, <stepName=None>)
引数 | 定義 |
---|---|
|
属性共有プラグインを挿入するauthnModuleの名前。 |
|
その後で属性共有ステップ(または指定した名前のステップ)を挿入するステップの名前。 |
|
fromStepの後で属性共有ステップ(または指定した名前のステップ)を呼び出す条件。OnSuccess、OnFailureまたはOnErrorのいずれかである必要があります。 |
|
属性共有ステップ(または指定した名前のステップ)の後で移動先となるステップの名前。 |
|
属性共有ステップ(または指定した名前のステップ)の後でtoStepを呼び出す条件。 |
|
フローに追加中のステップの名前。 |
例
insertAttributeSharingInToAuthnModule(authnModule="LDAPPlugin", fromStep="stepUA", fromCond="OnSuccess") insertAttributeSharingInToAuthnModule(authnModule="LDAPPlugin", fromStep="stepUA", fromCond="OnSuccess", stepName="success")
3.2.14 addSPPartnerAuthnMethod
addSPPartnerAuthnMethodコマンドは、フェデレーテッド認証メソッドと特定のSPパートナのAccess Manager認証スキームの間のマッピングを定義します。
説明
SPパートナのAccess Manager認証スキームにフェデレーテッド認証メソッドをマップします。
構文
addSPPartnerAuthnMethod(partner, authnMethod, authnScheme, isDefault="true", authnLevel="-1", appDomain="IAM Suite", hostID="IAMSuiteAgent", <authzPolicy="Protected Resource Policy">)
引数 | 定義 |
---|---|
|
SPパートナのID。 |
|
Access Managerの認証スキームがマップされるフェデレーション認証メソッド。 |
|
フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。 |
|
オプション。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。 |
|
オプション。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。 |
|
オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。 |
|
オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。 |
|
オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。 |
例
addSPPartnerAuthnMethod("acmeSP", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "LDAPScheme")
3.2.15 addSPPartnerProfileAuthnMethod
addSPPartnerProfileAuthnMethodコマンドは、フェデレーテッド認証メソッドから特定のSPパートナ・プロファイルのAccess Manager認証スキームへのマッピングを定義します。
説明
SPパートナ・プロファイルのAccess Manager認証スキームにフェデレーテッド認証メソッドをマップします。
構文
addSPPartnerProfileAuthnMethod(partnerProfile, authnMethod, authnScheme, isDefault="true", authnLevel="-1", appDomain="IAM Suite", hostID="IAMSuiteAgent", <authzPolicy="Protected Resource Policy">)
引数 | 定義 |
---|---|
|
SPパートナ・プロファイルのID。 |
|
Access Managerの認証スキームがマップされるフェデレーション認証メソッド。 |
|
フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。 |
|
オプション。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。 |
|
オプション。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。 |
|
オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。 |
hostID |
オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。 |
|
オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。 |
例
addSPPartnerProfileAuthnMethod("saml20-sp-partner-profile", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "LDAPScheme")
3.2.16 addIdPPartnerAuthnMethod
addIdPPartnerAuthnMethodコマンドは、特定のIdPパートナのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。
説明
このIdPパートナのユーザーが認証されるレベルを定義します。
構文
addIdPPartnerAuthnMethod(partner, authnMethod, authnLevel)
引数 | 定義 |
---|---|
|
SPパートナ・プロファイルのID。 |
|
フェデレーテッド認証メソッド。 |
|
指定されたフェデレーテッド認証メソッドのフェデレーションSSOフロー中にAccess Managerユーザー・セッションを作成するために使用するレベル。 |
例
addIdPPartnerAuthnMethod("acmeIdP", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "1")
3.2.17 addIdPPartnerProfileAuthnMethod
addIdPPartnerProfileAuthnMethodコマンドは、特定のIdPパートナ・プロファイルのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。
説明
このIdPパートナ・プロファイルのユーザーが認証されるレベルを定義します。
構文
addIdPPartnerProfileAuthnMethod(partnerProfile, authnMethod, authnLevel)
引数 | 定義 |
---|---|
|
SPパートナ・プロファイルのID。 |
|
フェデレーテッド認証メソッド。 |
|
指定されたフェデレーテッド認証メソッドのフェデレーションSSOフロー中にAccess Managerユーザー・セッションを作成するために使用するレベル。 |
例
addIdPPartnerProfileAuthnMethod("saml20-idp-partner-profile", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "1")
3.2.18 listPartnerAuthnMethods
listPartnerAuthnMethodsコマンドは、特定のパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。
説明
指定されたパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。
構文
listPartnerAuthnMethods(partner, partnerType)
引数 | 定義 |
---|---|
|
パートナのID |
|
パートナのタイプ(SPまたはIdP) |
例
listPartnerAuthnMethods("acmeSP", "SP")
3.2.19 listPartnerProfileAuthnMethods
listPartnerProfileAuthnMethodsコマンドは、特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。
説明
指定されたパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。
構文
listPartnerProfileAuthnMethods(partnerProfile, partnerType)
引数 | 定義 |
---|---|
|
パートナ・プロファイルのID |
|
パートナのタイプ(SPまたはIdP) |
例
listPartnerProfileAuthnMethods("saml20-sp-partner-profile", "SP")
3.2.20 removePartnerAuthnMethod
removePartnerAuthnMethodコマンドは、フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。
説明
フェデレーテッド認証メソッドと指定したパートナのAccess Manager認証スキームの間のマッピングを削除します。
構文
removePartnerAuthnMethod(<partner>, <partnerType>, <authnMethod>)
引数 | 定義 |
---|---|
|
パートナのID |
|
パートナのタイプ(SPまたはIdP) |
|
Access Manager認証スキーム。 |
例
removePartnerAuthnMethod("acmeSP", "SP", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")
3.2.21 removePartnerProfileAuthnMethod
removePartnerProfileAuthnMethodコマンドは、フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。
説明
フェデレーテッド認証メソッドと指定したパートナのAccess Manager認証スキームの間のマッピングを削除します。
構文
removePartnerProfileAuthnMethod(<partnerProfile>, <partnerType>, <authnMethod>)
引数 | 定義 |
---|---|
|
パートナ・プロファイルのID |
|
パートナのタイプ(SPまたはIdP) |
|
フェデレーテッド認証メソッド。 |
例
removePartnerProfileAuthnMethod("saml20-sp-partner-profile", "SP", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")
3.2.22 setIdPPartnerRequestAuthnMethod
setIdPPartnerRequestAuthnMethodコマンドは、特定のIdPパートナのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。
説明
指定したIdPパートナのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。
構文
setIdPPartnerRequestAuthnMethod(<partner>, <authnMethod>)
引数 | 定義 |
---|---|
|
IdPパートナのID |
|
フェデレーテッド認証メソッド。 |
例
setIdPPartnerRequestAuthnMethod("acmeIdP", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")
3.2.23 setIdPPartnerProfileRequestAuthnMethod
setIdPPartnerProfileRequestAuthnMethodコマンドは、指定したIdPパートナ・プロファイルのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。
説明
指定したIdPパートナ・プロファイルのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。
構文
setIdPPartnerProfileRequestAuthnMethod(<partnerProfile>, <authnMethod>)
引数 | 定義 |
---|---|
|
IdPパートナ・プロファイルのID |
|
フェデレーテッド認証メソッド。 |
例
setIdPPartnerProfileRequestAuthnMethod("saml20-idp-partner-profile", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")
3.2.24 useProxiedFedAuthnMethod
useProxiedFedAuthnMethodコマンドは、フェデレーションSSOを実行するときに、プロキシ処理されたフェデレーテッド認証メソッドを使用するアイデンティティ・プロバイダを構成します。
説明
サーバーがリモートIdPを使用してSPとして機能してユーザーを認証する場合、サーバーは別のフェデレーションSSO操作でアイデンティティ・プロバイダとして機能するときに、リモート・アイデンティティ・プロバイダによって送信されたフェデレーション認証メソッドを使用できます。サーバーは、指定したフェデレーション認証スキームの一覧に対して、プロキシ処理されたフェデレーション認証メソッドを送信します。サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するのは、サーバーとサービス・プロバイダの間で使用されるフェデレーション・プロトコルが、サーバーとアイデンティティ・プロバイダの間で使用されるのと同じフェデレーション・プロトコルである場合のみです。
構文
useProxiedFedAuthnMethod(<enabled="false">, <displayOnly="false">, <authnSchemeToAdd="">, <authnSchemeToRemove="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">)
引数 | 定義 |
---|---|
|
プロキシ処理されたフェデレーション認証メソッドを使用するかどうかを示します。デフォルトでは、機能が無効になります。オプション。 |
|
このコマンドが、サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するフェデレーション・スキームを一覧表示するかどうかを示します。デフォルトはfalseです。オプション。 |
|
サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するスキームの一覧に追加するOAMフェデレーション認証スキーム。authnSchemeToAddおよびauthnSchemeToRemoveパラメータは排他的です。 |
|
サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するスキームの一覧から削除するOAMフェデレーション認証スキーム。authnSchemeToAddおよびauthnSchemeToRemoveパラメータは排他的です。 |
|
基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。オプション。 |
|
基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。オプション。 |
|
オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。 |
例
useProxiedFedAuthnMethod(enabled="true", authnSchemeToAdd="FederationScheme")
3.2.25 createFedPartnerProfileFrom
createFedPartnerProfileFromコマンドは、指定した既存のプロファイルに基づいてフェデレーション・パートナ・プロファイルを作成します。
説明
指定した既存のパートナ・プロファイルに基づいて新しいパートナ・プロファイルを作成します。
構文
createFedPartnerProfileFrom(<newPartnerProfile>, <existingPartnerProfile>)
引数 | 定義 |
---|---|
|
新しいパートナ・プロファイルのID。 |
|
既存のパートナ・プロファイルのID。 |
例
createFedPartnerProfileFrom("newAcmeSPProfile", "acmeSPProfile")
3.2.26 deleteFedPartnerProfile
deleteFedPartnerProfileコマンドは、指定したフェデレーション・パートナ・プロファイルを削除します。
説明
指定したパートナ・プロファイルを削除します。
構文
deleteFedPartnerProfile(<PartnerProfile>)
引数 | 定義 |
---|---|
|
削除するパートナ・プロファイルのID。 |
例
deleteFedPartnerProfile("acmeSPProfile")
3.2.27 displayFedPartnerProfile
displayFedPartnerProfileコマンドは、指定したフェデレーション・パートナ・プロファイルで定義されているプロパティを表示します。
説明
指定したフェデレーション・パートナ・プロファイルのプロパティを表示します。
構文
displayFedPartnerProfile(<PartnerProfile>)
引数 | 定義 |
---|---|
|
パートナ・プロファイルのID。 |
例
displayFedPartnerProfile("saml20-idp-partner-profile")
3.2.28 listFedPartnerProfiles
listFedPartnerProfilesコマンドは、既存のすべてのフェデレーション・パートナ・プロファイルを一覧表示します。
説明
既存のフェデレーション・パートナ・プロファイルを一覧表示します。
構文
listFedPartnerProfiles()
このコマンドには、引数はありません。
例
listFedPartnerProfiles()
3.2.29 listFedPartnersForProfile
listFedPartnersForProfileコマンドは、指定したフェデレーション・パートナ・プロファイルにバインドされたパートナを一覧表示します。
説明
指定したフェデレーション・パートナ・プロファイルにバインドされたすべてのパートナを一覧表示します。
構文
listFedPartnersForProfile(<PartnerProfile>)
引数 | 定義 |
---|---|
|
パートナ・プロファイルのID。 |
例
listFedPartnersForProfile("acmeSPProfile")
3.2.30 getFedPartnerProfile
getFedPartnerProfileコマンドは、指定したパートナにバインドされたパートナ・プロファイルのIDを取得します。
説明
指定したパートナにバインドされたパートナ・プロファイルのIDを取得します。
構文
getFedPartnerProfile(<partner>, <partnerType>)
引数 | 定義 |
---|---|
|
パートナのID。 |
|
パートナのタイプ(spまたはidp)。 |
例
getFedPartnerProfile("acmeIDP", "idp")
3.2.31 setFedPartnerProfile
setFedPartnerProfileコマンドは、指定したパートナのフェデレーション・パートナ・プロファイルのIDを設定します。
説明
指定したパートナ・プロファイルのIDに基づいて指定したパートナ・プロファイルのパートナ・プロファイルを設定します。
構文
setFedPartnerProfile(<partner>, <partnerType>, <partnerProfile>)
引数 | 定義 |
---|---|
|
パートナのID。 |
|
パートナのタイプ(spまたはidp)。 |
|
パートナ・プロファイルのID。 |
例
setFedPartnerProfile("acmeIDP", "idp", "saml20-idp-partner-profile")
3.2.32 idpinitiatedssoprovideridparam
idpinitiatedssoprovideridparamコマンドは、SPのプロバイダIDを識別するための値を設定します。
説明
idpinitiatedssoprovideridparam
によって保持される値は、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")
3.2.33 idpinitiatedssotargetparam
idpinitiatedssotargetparamコマンドは、指定したSPパートナのターゲットURLを設定します。
説明
ターゲット・リソースを識別します。idpinitiatedssotargetparam
によって保持される値は、必要なリソースを識別するためにピア・プロバイダによって使用されます。Oracle Identity Federationの場合はTARGETです。
構文
updatePartnerProperty(partnerName, partnerType, "idpinitiatedssotargetparam", "TARGET", "string")
引数 | 定義 |
---|---|
partnerName |
パートナのID |
partnerType |
値にidpまたはspを取ります。 |
propName |
構成または変更するプロパティの名前。 |
propValue |
リソースの場所。デフォルト値は |
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")
3.2.34 subjectconfirmationcheck
subjectconfirmationcheckコマンドは、サブジェクト確認データ・チェックを有効または無効にします。
説明
SAMLアサーションのサブジェクト確認データ・チェックを有効または無効にします。
構文
updatePartnerProperty(partnerName,partnerType,propName,propValue,type)
引数 | 定義 |
---|---|
|
更新するパートナのID。 |
|
パートナ・タイプを指定します。有効な値は、spまたはidpです。 |
|
プロパティ名を'subjectconfirmationcheck'に設定します。 |
|
プロパティの値を指定します。有効な値はtrueまたはfalseです。 |
|
プロパティのデータ型。booleanのみを設定可能です。 |
例
updatePartnerProperty(partnerName="testIDP", partnerType="IDP", propName="subjectconfirmationcheck", propValue="true",type="boolean")