9 Oracle Identity Federationコマンドライン・ツール

この章では、Oracle Identity Federationで使用可能なコマンドライン・ツールについて説明します。

• Oracle Identity Federationのコマンドライン・ツールの概要

• Oracle Identity Federationのコマンド

9.1 Oracle Identity Federationのコマンドライン・ツールの概要

WLSTは、Oracle Fusion Middlewareのコンポーネントとアプリケーションの管理に使用するコマンドライン・ユーティリティです。Oracle Enterprise Manager Fusion Middleware Controlに加えて、管理のための別のオプションが用意されています。

関連項目: WLSTユーティリティのバックグラウンド情報および説明の詳細は、Oracle Fusion Middleware WebLogic Scripting Toolコマンド・リファレンスを参照してください。

WLSTコマンドライン・ユーティリティには、Oracle Identity Federationを管理するための様々なツールが用意されています。たとえば、次のような管理に対するコマンドがあります。

• プロパティ管理

• フェデレーション管理

• カスタムSPおよび認証エンジンの管理

• メッセージ・ストアのメンテナンス

9.1.1 WLST環境の設定

WLSTコマンドを実行するには、次のコマンドを実行して環境を設定します。

Linuxの場合

Linuxシステムで環境を設定するための構文は次のとおりです。

bash

export $DOMAIN_HOME=PATH_TO_DOMAIN_HOME

source $ORACLE_HOME/fed/scripts/setOIFEnv.sh 
(replace $ORACLE_HOME with the correct path for your environment.)

Windowsの場合

Windowsシステムで環境を設定するための構文は次のとおりです。

set DOMAIN_HOME=PATH_TO_DOMAIN_HOME
 
%ORACLE_HOME%/fed/scripts/setOIFEnv.cmd

9.1.2 コマンドの実行

次のコマンドを実行してOracle Identity FederationのWLSTスクリプト環境を入力します。

java weblogic.WLST

コマンドを実行するには次の形式を使用します。

command-name('param1','param2',...)

次に例を示します。

deleteUserFederations(['user1','user2'])

注意: connect() URLの入力を求められたら、管理対象サーバーのポートを入力します(管理サーバーのポートではありません)。

9.2 Oracle Identity Federationのコマンド

表9-1に示すWLSTコマンドを使用して、Oracle Identity Federationの構成を表示および管理します。

表9-1 Oracle Identity FederationのWLSTコマンド

使用するコマンド	機能	WLSTでの使用
addConfigListEntryInMap	構成リスト・エントリをマップに追加します。	オンライン
addConfigMapEntryInMap	構成マップ・エントリをマップに追加します。	オンライン
addConfigPropertyListEntry	構成プロパティ・リスト・エントリを追加します。	オンライン
addConfigPropertyMapEntry	構成プロパティ・マップ・エントリを追加します。	オンライン
addCustomAuthnEngine	カスタム認証エンジンを追加します。	オンライン
addCustomSPEngine	カスタムSPエンジンを追加します。	オンライン
addFederationListEntryInMap	特定のリモート・プロバイダの構成のマップにリスト・エントリを追加します。	オンライン
addFederationMapEntryInMap	特定のリモート・プロバイダの構成のマップにマップ・エントリを追加します。	オンライン
addFederationPropertyListEntry	特定のリモート・プロバイダの構成にプロパティ・リスト・エントリを追加します。	オンライン
addFederationPropertyMapEntry	特定のリモート・プロバイダの構成にマップ・エントリを追加します。	オンライン
deleteCustomAuthnEngine	カスタム認証エンジンを削除します。	オンライン
deleteCustomSPEngine	カスタムSPエンジンを削除します。	オンライン
deleteProviderFederation	特定のプロバイダのフェデレーテッド・アイデンティティを削除します。	オンライン
deleteUserFederations	特定のユーザーのフェデレーテッド・アイデンティティを削除します。	オンライン
changeMessageStore	メッセージ・ストアをメモリーまたはRDBMSに変更します。	オンライン
changePeerProviderDescription	ピア・プロバイダの説明を変更します。	オンライン
changeSessionStore	セッション・ストアをメモリーまたはRDBMSに変更します。	オンライン
createConfigPropertyList	構成プロパティ・リストを作成します。	オンライン
createConfigPropertyListInMap	マップに構成プロパティ・リストを作成します。	オンライン
createConfigPropertyMap	構成プロパティ・マップを作成します。	オンライン
createConfigPropertyMapInMap	マップの中に、構成プロパティ・マップをネストして作成します。	オンライン
createFederationPropertyList	特定のリモート・プロバイダの構成にプロパティ・リストを作成します。	オンライン
createFederationPropertyListInMap	特定のリモート・プロバイダの構成のマップにプロパティ・リストを作成します。	オンライン
createFederationPropertyMap	特定のリモート・プロバイダの構成にプロパティ・マップを作成します。	オンライン
createFederationPropertyMapInMap	特定のリモート・プロバイダの構成のマップに、ネストされたプロパティ・マップを作成します。	オンライン
createPeerProviderEntry	ピア・プロバイダ・エントリを作成します。	オンライン
getConfigListValueInMap	マップから構成リスト値を取得します。	オンライン
getConfigMapEntryInMap	マップから構成マップ値を取得します。	オンライン
getConfigProperty	構成プロパティ・エントリを取得します。	オンライン
getConfigPropertyList	構成プロパティ・リストを取得します。	オンライン
getConfigPropertyMapEntry	構成プロパティ・マップ・エントリを取得します。	オンライン
getFederationListValueInMap	特定のリモート・プロバイダの構成のマップからプロパティ・リスト値を取得します。	オンライン
getFederationMapEntryInMap	特定のリモート・プロバイダの構成のマップからプロパティ・マップ値を取得します。	オンライン
getFederationProperty	特定のリモート・プロバイダの構成からプロパティ値を取得します。	オンライン
getFederationPropertyList	特定のリモート・プロバイダの構成からプロパティ・リストを取得します。	オンライン
extractproviderprops	すべてのプロバイダ構成プロパティをテキスト・ファイルにエクスポートします。	スクリプト
setproviderprops	プロバイダのプロパティを入力テキスト・ファイルに基づいて設定します。	スクリプト
getFederationPropertyMapEntry	特定のリモート・プロバイダの構成からプロパティ・マップ・エントリを取得します。	オンライン
listCustomAuthnEngines	カスタム認証エンジンのリストを表示します。	オンライン
listCustomSPEngines	カスタムSPエンジンのリストを表示します。	オンライン
loadMetadata	ファイルからメタデータをロードします。	オンライン
oifStatus	Oracle Identity Federationサーバーのステータスを表示します。	オンライン
removeConfigListInMap	マップから構成リストを削除します。	オンライン
removeConfigMapEntryInMap	マップ内の構成マップ・エントリを削除します。	オンライン
removeConfigMapInMap	ネストされた構成マップを削除します。	オンライン
removeConfigProperty	構成プロパティを削除します。	オンライン
removeConfigPropertyList	プロパティ・リストを削除します。	オンライン
removeConfigPropertyMap	プロパティ・マップを削除します。	オンライン
removeConfigPropertyMapEntry	プロパティ・マップ内のエントリを削除します。	オンライン
removeFederationListInMap	特定のリモート・プロバイダの構成のマップからリストを削除します。	オンライン
removeFederationMapInMap	特定のリモート・プロバイダの構成のマップからネストされたマップを削除します。	オンライン
removeFederationMapEntryInMap	特定のリモート・プロバイダの構成のマップからネストされたマップ・プロパティ・エントリを削除します。	オンライン
removeFederationProperty	特定のリモート・プロバイダの構成のプロパティを削除します。	オンライン
removeFederationPropertyList	特定のリモート・プロバイダの構成のプロパティ・リストを削除します。	オンライン
removeFederationPropertyMap	プロパティ・マップを削除します。	オンライン
removeFederationPropertyMapEntry	特定のリモート・プロバイダの構成のマップからプロパティを削除します。	オンライン
removePeerProviderEntry	ピア・プロバイダ・エントリを削除します。	オンライン
setConfigProperty	構成プロパティを設定します。	オンライン
setCustomAuthnEngine	カスタム認証エンジンを定義します。	オンライン
setCustomSPEngine	カスタムSPエンジンを定義します。	オンライン
setFederationProperty	特定のリモート・プロバイダの構成にプロパティを設定します。	オンライン

詳細は、『Oracle Fusion Middleware Oracle Identity Federation管理者ガイド』を参照してください。

9.2.1 addConfigListEntryInMap

マップの中にネストされているリストにプロパティ値を追加するオンライン・コマンドです。

9.2.1.1 説明

このコマンドは、config.xml内のマップの中にネストされているリストにプロパティ値を追加します。

9.2.1.2 構文

addConfigListEntryInMap('configName', 'mapname', 'listName', 'value', 'type')

引数	定義
configname	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapname	config.xml内の変更するプロパティ・マップの名前を指定します。
listname	リストの名前を指定します。
value	プロパティ値を指定します。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.1.3 例

次のコマンドは、サーバー構成のマップ・リストにvalueAを追加します。

wls:/mydomain/serverConfig> addConfigListEntryInMap('serverconfig','mymap','mylistA','valueA','string')

9.2.2 addConfigMapEntryInMap

マップに、ネストされたマップ・プロパティ・エントリを追加するオンライン・コマンドです。

9.2.2.1 説明

このコマンドは、config.xml内のマップの中にネストされているマップにプロパティ名/値ペアを追加します。

9.2.2.2 構文

addConfigMapEntryInMap('configName', 'mapname', 'nestedMapName', 'propName', 'value', 'type')

引数	定義
configname	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapname	config.xml内の変更するプロパティ・マップの名前を指定します。
nestedmapname	変更するネストされたプロパティ・マップの名前を示します。
propname	リストの名前を指定します。
value	プロパティ値を指定します。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.2.3 例

次のコマンドは、マップmymapの中のnestedmapBにブール型の名前/値ペアを追加します。

wls:/mydomain/serverConfig> addConfigMapEntryInMap('serverconfig','mymap','nestedmapB','myvarB','true',
'boolean')

9.2.3 addConfigPropertyListEntry

config.xmlにリスト・プロパティ・エントリを追加するオンライン・コマンドです。

9.2.3.1 説明

このコマンドは、config.xml内のリストにプロパティ値を追加します。

9.2.3.2 構文

addConfigPropertyListEntry('configName', 'listName', 'value', 'type')

引数	定義
configname	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
listname	config.xml内の更新するプロパティ・リストの名前を指定します。
value	新しいプロパティ・リスト値を指定します。入力した値がリストに追加されます。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.3.3 例

次のコマンドは、mylistAに文字列値を追加します。

wls:/mydomain/serverConfig> addConfigPropertyListEntry('serverconfig','mylistA','valueA','string')

9.2.4 addConfigPropertyMapEntry

config.xml内のマップにプロパティ名/値エントリを追加するオンライン・コマンドです。

9.2.4.1 説明

このコマンドは、config.xml内のマップにプロパティ名/値エントリを追加します。

9.2.4.2 構文

addConfigPropertyMapEntry('configName', 'mapName', 'propName','value', 'type')

引数	定義
configname	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapname	config.xmlのプロパティ・マップの名前を指定します。
propname	プロパティ・マップの名前を指定します。
value	追加するプロパティ・マップ値を指定します。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.4.3 例

次のコマンドは、マップに文字列型のvalueAを追加します。

wls:/mydomain/serverConfig> addConfigPropertyMapEntry('serverconfig','mymapA','myvarA','valueA','string')

9.2.5 addCustomAuthnEngine

カスタム認証統合エンジンを追加するオンライン・コマンドです。

9.2.5.1 説明

このコマンドは、config.xmlにカスタム認証統合エンジンを追加します。

9.2.5.2 構文

addCustomAuthnEngine('name' 'enabled' 'webContext' 'authnRelativePath' 'logoutRelativePath' 'logoutEnabled')

引数	定義
name	カスタム・エンジンの名前を指定します。
enabled	このフラグには、エンジンを有効にする(true)か、無効にする(false)かを指定します。
webContext	エンジンのWebコンテキストを指定します。
authnRelativePath	エンジンの認証相対パスURLを指定します。
logoutRelativePath	エンジンのログアウト相対パスURLを指定します。
logoutEnabled	このフラグは、エンジンのログアウトを有効にする場合はtrueに設定します。それ以外の場合はfalseに設定します。

9.2.5.3 例

次のコマンドは、testという名前のエンジンを定義し、有効に設定します。

wls:/mydomain/serverConfig> addCustomAuthnEngine('test','true')

9.2.6 addCustomSPEngine

カスタム・サービス・プロバイダ(SP)エンジンを追加するオンライン・コマンドです。

9.2.6.1 説明

このコマンドは、config.xmlにカスタムSP統合エンジンを追加します。

9.2.6.2 構文

addCustomSPEngine('name' 'enabled' 'authnMech' 'webContext' 'authnRelativePath' 'logoutRelativePath' 'logoutEnabled')

引数	定義
name	カスタム・エンジンの名前を指定します。
enabled	このフラグには、エンジンを有効にする(true)か、無効にする(false)かを指定します。
authnMech	エンジンの認証メカニズムを指定します。
webContext	エンジンのWebコンテキストを指定します。
authnRelativePath	エンジンの認証相対パスURLを指定します。
logoutRelativePath	エンジンのログアウト相対パスURLを指定します。
logoutEnabled	このフラグは、エンジンのログアウトを有効にする場合はtrueに設定します。それ以外の場合はfalseに設定します。

9.2.6.3 例

次のコマンドは、エンジンを追加し、そのステータスを無効に設定します。

addCustomSPEngine('new engine','false','oracle:fed:authentication:unspecified','webcontext')

9.2.7 addFederationListEntryInMap

マップにリスト・プロパティ・エントリを追加するオンライン・コマンドです。

9.2.7.1 説明

このコマンドは、cot.xml内のマップの中にネストされているリストにプロパティ値を追加します。

9.2.7.2 構文

addFederationListEntryInMap('providerID', 'mapname', 'listName', 'value', 'type')

引数	定義
providerID	プロバイダIDを指定します。
mapname	cot.xml内の変更するプロパティ・マップの名前を指定します。
listname	マップに追加するプロパティ・リストの名前を指定します。
value	追加するプロパティ・リスト値を指定します。入力した値がリストに追加されます。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.7.3 例

次のコマンドは、mymapにブール型プロパティ・リストを追加します。

wls:/mydomain/serverConfig> addFederationListEntryInMap('providerB','mymap','mylistB','true','boolean')

9.2.8 addFederationMapEntryInMap

マップに、ネストされたマップ・プロパティ・エントリを追加するオンライン・コマンドです。

9.2.8.1 説明

このコマンドは、cot.xml内のマップの中にネストされているマップにプロパティ名/値ペアを追加します。

9.2.8.2 構文

addFederationMapEntryInMap('providerID', 'mapname', 'nestedMapName', 'propName', 'value', 'type')

引数	定義
providerID	プロバイダIDを指定します。
mapname	cot.xml内の変更するプロパティ・マップの名前を指定します。
nestedMapName	変更するネストされたプロパティ・マップの名前を指定します。
propName	マップで更新するプロパティの名前を指定します。
value	追加するプロパティ値を指定します。入力した値がリストに追加されます。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.8.3 例

次のコマンドは、ネストされたマップの中にあるmyvarAプロパティに、文字列型の値を追加します。

wls:/mydomain/serverConfig> addFederationMapEntryInMap('providerA','mymap','nestedmapA','myvarA','valueA',
'string')

9.2.9 addFederationPropertyListEntry

リスト・プロパティ・エントリを追加するオンライン・コマンドです。

9.2.9.1 説明

このコマンドは、cot.xml内のリストにプロパティ値を追加します。

9.2.9.2 構文

addFederationPropertyListEntry('providerID', 'listName', 'value', 'type')

引数	定義
providerID	プロバイダIDを指定します。
listname	更新するプロパティ・リストの名前を指定します。
value	追加するプロパティ・リスト値を指定します。入力した値がリストに追加されます。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.9.3 例

次のコマンドは、指定したプロパティ・リストに文字列型の値を追加します。

wls:/mydomain/serverConfig> addFederationPropertyListEntry('providerA','mylistA','valueA','string')

9.2.10 addFederationPropertyMapEntry

マップにプロパティ名/値エントリを追加するオンライン・コマンドです。

9.2.10.1 説明

このコマンドは、cot.xml内のマップにプロパティ名/値ペアを追加します。

9.2.10.2 構文

addFederationPropertyMapEntry('providerID', 'mapName', 'propName','value', 'type')

引数	定義
providerID	プロバイダIDを指定します。
mapname	cot.xml内の変更するプロパティ・マップの名前を指定します。
propName	マップに追加するプロパティの名前を指定します。
value	追加するプロパティ値を指定します。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.10.3 例

次のコマンドは、マップにブール型プロパティmyvarBを追加します。

wls:/mydomain/serverConfig> addFederationPropertyMapEntry('providerA','mymapB','myvarB','true','boolean')

9.2.11 deleteCustomAuthnEngine

構成からカスタム認証統合エンジンを削除するオンライン・コマンドです。

9.2.11.1 説明

このコマンドは、config.xml内のカスタム認証統合エンジンを削除します。config.xml内の既存のカスタム認証エンジンのエンジンIDを指定する必要があります。

9.2.11.2 構文

deleteCustomAuthnEngine('engineID')

引数	定義
engineID	削除する既存のエンジンのエンジンIDを指定します。

9.2.11.3 例

次のコマンドは、id1234というIDの認証エンジンを削除します。

wls:/mydomain/serverConfig> deleteCustomAuthnEngine('id1234')

9.2.12 deleteCustomSPEngine

構成からカスタム・サービス・プロバイダ(SP)統合エンジンを削除するオンライン・コマンドです。

9.2.12.1 説明

このコマンドは、config.xml内のカスタムSP統合エンジンを削除します。config.xml内の既存のカスタムSPエンジンのエンジンIDを指定する必要があります。

9.2.12.2 構文

ddeleteCustomSPEngine('engineID')

引数	定義
engineID	削除する既存のエンジンのエンジンIDを指定します。

9.2.12.3 例

次のコマンドは、id1234というIDのエンジンを削除します。

wls:/mydomain/serverConfig> deleteCustomSPEngine('id1234')

9.2.13 deleteProviderFederation

指定したプロバイダのフェデレーションを削除するオンライン・コマンドです。

9.2.13.1 説明

このコマンドは、指定したプロバイダIDのフェデレーションを削除します。

9.2.13.2 構文

deleteProviderFederation('providerID')

引数	定義
providerID	フェデレーションを削除するピア・プロバイダのプロバイダIDを指定します。

9.2.13.3 例

次のコマンドは、providerAを削除します。

wls:/mydomain/serverConfig> deleteProviderFederation(providerA)

9.2.14 deleteUserFederations

指定したユーザーのフェデレーションを削除するオンライン・コマンドです。

9.2.14.1 説明

このコマンドは、指定したユーザーのリストのフェデレーションを削除します。

9.2.14.2 構文

deleteUserFederations(['user1,..'])

引数	定義
user1	フェデレーションを削除するユーザーのコンマ区切りのリストを指定します。1つ以上のユーザーを指定する必要があります。

9.2.14.3 例

次のコマンドは、3つのユーザーのフェデレーションを削除します。

wls:/mydomain/serverConfig> deleteUserFederations(['userA','userB','userC'])

9.2.15 changeMessageStore

メッセージ・ストアをメモリーとRDBMSとの間で切り替えるオンライン・コマンドです。

9.2.15.1 説明

このコマンドは、メッセージ・ストアをメモリーまたはRDBMSに変更します。

9.2.15.2 構文

changeMessageStore('type','jndiname')

引数	定義
type	ストアのタイプ(RDBMSまたはメモリー)を指定します。デフォルトはメモリーです。
jndiname	ストアに設定するjndi名を指定します。タイプがRDBMSの場合は必須です。

9.2.15.3 例

次のコマンドは、メッセージ・ストアをRDBMSに変更します。

wls:/mydomain/serverConfig> changeMessageStore('RDBMS','jdbc/mydb')

9.2.16 changePeerProviderDescription

ピア・プロバイダの説明を変更するオンライン・コマンドです。

9.2.16.1 説明

このコマンドは、cot.xml内のピア・プロバイダの説明を更新します。

9.2.16.2 構文

changePeerProviderDescription('providerID','description')

引数	定義
providerID	プロバイダIDを指定します。
description	プロバイダの説明を指定します。

9.2.16.3 例

次のコマンドは、プロバイダの説明を更新します。

wls:/mydomain/serverConfig> changePeerProviderDescription('providerA','new description')

9.2.17 changeSessionStore

セッション・ストアをメモリーとRDBMSとの間で切り替えるオンライン・コマンドです。

9.2.17.1 説明

このコマンドは、セッション・ストアをメモリーまたはRDBMSに変更します。

9.2.17.2 構文

changeSessionStore('type','jndiname')

引数	定義
type	ストアのタイプ(RDBMSまたはメモリー)を指定します。デフォルトはメモリーです。
jndiname	ストアに設定するjndi名を指定します。タイプがRDBMSの場合は必須です。

9.2.17.3 例

次のコマンドは、セッション・ストアをRDBMSに変更します。

wls:/mydomain/serverConfig> changeSessionStore('RDBMS','jdbc/mydb')

9.2.18 createConfigPropertyList

プロパティ・リストを作成するオンライン・コマンドです。

9.2.18.1 説明

このコマンドは、config.xmlにプロパティ・リストを作成します。

9.2.18.2 構文

createConfigPropertyList('configName', 'listName')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
listName	プロパティ・リスト名を指定します。

9.2.18.3 例

次のコマンドは、プロパティ・リストmylistAを作成します。

wls:/mydomain/serverConfig> createConfigPropertyList('serverconfig','mylistA')

9.2.19 createConfigPropertyListInMap

プロパティ・マップの中にネストされたプロパティ・リストを作成するオンライン・コマンドです。

9.2.19.1 説明

このコマンドは、config.xml内のプロパティ・マップの中に、プロパティ・リストをネストして作成します。

9.2.19.2 構文

createConfigPropertyListInMap('configName', 'mapName', 'listName')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	ネストされたリストを含める既存のプロパティ・マップを指定します。
listName	プロパティ・リスト名を指定します。

9.2.19.3 例

次のコマンドは、プロパティ・マップの中に、プロパティ・リストmylistAをネストして作成します。

wls:/mydomain/serverConfig> createConfigPropertyListInMap('serverconfig','mymapA','mylistA')

9.2.20 createConfigPropertyMap

プロパティ・マップを作成するオンライン・コマンドです。

9.2.20.1 説明

このコマンドは、config.xmlにプロパティ・マップを作成します。

9.2.20.2 構文

createConfigPropertyMap('configName', 'mapName')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	作成するプロパティ・マップを指定します。

9.2.20.3 例

次のコマンドは、プロパティ・マップmymapAを作成します。

wls:/mydomain/serverConfig> createConfigPropertyMap('serverconfig','mymapA')

9.2.21 createConfigPropertyMapInMap

プロパティ・マップを作成するオンライン・コマンドです。

9.2.21.1 説明

このコマンドは、config.xmlにプロパティ・マップを作成します。

9.2.21.2 構文

ccreateConfigPropertyMapInMap('serverconfig','mymapA','nestedmapA')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	既存のプロパティ・マップの名前を指定します。
nestedMapName	mapNameの中にネストして作成するプロパティ・マップの名前を指定します。

9.2.21.3 例

次のコマンドは、ネストされたプロパティ・マップnestedmymapAを作成します。

wls:/mydomain/serverConfig> createConfigPropertyMapInMap('serverconfig','mymapA','nestedmapA')

9.2.22 createFederationPropertyList

プロパティ・リストを作成するオンライン・コマンドです。

9.2.22.1 説明

このコマンドは、cot.xmlにプロパティ・リストを作成します。

9.2.22.2 構文

引数	定義
providerID	プロバイダIDを指定します。
listName	プロパティ・リストの名前を指定します。

9.2.22.3 例

次のコマンドは、プロパティ・リストmylistAを作成します。

wls:/mydomain/serverConfig> createFederationPropertyList('providerA','mylistA')

9.2.23 createFederationPropertyListInMap

プロパティ・マップの中にネストされたプロパティ・リストを作成するオンライン・コマンドです。

9.2.23.1 説明

このコマンドは、cot.xml内のプロパティ・マップの中に、プロパティ・リストをネストして作成します。

9.2.23.2 構文

createFederationPropertyListInMap('providerID', 'mapName', 'listName')

引数	定義
providerID	プロバイダIDを指定します。
mapName	ネストされたリストを含める既存のプロパティ・マップを指定します。
listName	プロパティ・リストの名前を指定します。

9.2.23.3 例

次のコマンドは、ネストされたプロパティ・リストmylistAを作成します。

wls:/mydomain/serverConfig> createFederationPropertyListInMap('providerA','mymapA','mylistA')

9.2.24 createFederationPropertyMap

プロパティ・マップを作成するオンライン・コマンドです。

9.2.24.1 説明

このコマンドは、cot.xmlにプロパティ・マップを作成します。

9.2.24.2 構文

createFederationPropertyMap('providerID', 'mapName')

引数	定義
providerID	プロバイダIDを指定します。
mapName	cot.xmlに追加するプロパティ・マップの名前を指定します。

9.2.24.3 例

次のコマンドは、プロパティ・マップmymapAを作成します。

wls:/mydomain/serverConfig> createFederationPropertyMap('providerA','mymapA')

9.2.25 createFederationPropertyMapInMap

ネストされたプロパティ・マップを作成するオンライン・コマンドです。

9.2.25.1 説明

このコマンドは、cot.xml内のプロパティ・マップの中に別のプロパティ・マップをネストして作成します。

9.2.25.2 構文

createFederationPropertyMapInMap('providerID', 'mapName', 'nestedMapName')

引数	定義
providerID	プロバイダIDを指定します。
mapName	既存のプロパティ・マップの名前を指定します。
nestedMapName	cot.xml内のmapNameの中にネストして作成するプロパティ・マップの名前を指定します。

9.2.25.3 例

次のコマンドは、ネストされたプロパティ・マップnestedmapAを作成します。

wls:/mydomain/serverConfig> createFederationPropertyMapInMap('providerA','mymapA','nestedmapA')

9.2.26 createPeerProviderEntry

ピア・プロバイダ・プロパティ・マップ・エントリを作成するオンライン・コマンドです。

9.2.26.1 説明

このコマンドは、cot.xmlにマップ・プロパティ・エントリとしてピア・プロバイダを作成します。

9.2.26.2 構文

createPeerProviderEntry('providerID', 'description', 'providerType','version')

引数	定義
providerID	作成するプロバイダIDを指定します。
description	プロバイダIDの説明です。
providerType	作成するピア・プロバイダのプロバイダ・タイプを指定します。
version	作成するピア・プロバイダのバージョンを指定します。

9.2.26.3 例

次のコマンドは、SAML 2.0サービス・プロバイダを作成します。

wls:/mydomain/serverConfig> createPeerProviderEntry('providerA','idp test','SP','SAML2.0')

9.2.27 getConfigListValueInMap

マップの中にネストされているリストを返すオンライン・コマンドです。

9.2.27.1 説明

このコマンドは、config.xml内のマップの中にネストされているリストを返します。

9.2.27.2 構文

getConfigListValueInMap('configName', 'mapName', 'listName')

引数	定義
configName	アクセスする構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	プロパティ・マップの名前を指定します。
listName	マップからフェッチするリストの名前を指定します。

9.2.27.3 例

次のコマンドは、mylistAを返します。

wls:/mydomain/serverConfig> getConfigListValueInMap('serverConfig','mymapA','mylistA'

9.2.28 getConfigMapEntryInMap

マップの中にネストされているマップ・プロパティ・エントリを返すオンライン・コマンドです。

9.2.28.1 説明

このコマンドは、config.xml内のマップの中にネストされているマップ・プロパティ・エントリを返します。

9.2.28.2 構文

getConfigMapEntryInMap('configName', 'mapname', 'nestedMapName', 'propName')

引数	定義
configName	アクセスする構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	プロパティ・マップの名前を指定します。
nestedmapName	ネストされたプロパティ・マップの名前を指定します。
propName	ネストされたマップからフェッチするプロパティの名前を指定します。

9.2.28.3 例

次のコマンドは、プロパティ・エントリmyvarAを返します。

wls:/mydomain/serverConfig> getConfigMapEntryInMap('serverconfig','mymap','nestedmapA','myvarA')

9.2.29 getConfigProperty

プロパティ値を返すオンライン・コマンドです。

9.2.29.1 説明

このコマンドは、config.xml内のプロパティ値を返します。

9.2.29.2 構文

getConfigProperty('configName', 'propName')

引数	定義
configName	アクセスする構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
propName	ネストされたマップからフェッチするプロパティの名前を指定します。

9.2.29.3 例

次のコマンドは、プロパティmyvarAを返します。

wls:/mydomain/serverConfig> getConfigProperty('serverconfig','myvarA')

9.2.30 getConfigPropertyList

プロパティ・リストを返すオンライン・コマンドです。

9.2.30.1 説明

このコマンドは、config.xml内のプロパティ・リストを返します。

9.2.30.2 構文

getConfigPropertyList('configName', 'listName')

引数	定義
configName	構成名を指定します。
listName	config.xmlからフェッチするプロパティ・リストの名前を指定します。

9.2.30.3 例

次のコマンドは、mylistAを返します。

wls:/mydomain/serverConfig> getConfigPropertyList('serverconfig','mylistA')

9.2.31 getConfigPropertyMapEntry

マップ内のプロパティ値を返すオンライン・コマンドです。

9.2.31.1 説明

このコマンドは、config.xml内のマップからプロパティ値を返します。

9.2.31.2 構文

getConfigPropertyMapEntry('configName', 'mapName', 'propName')

引数	定義
configName	構成名(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	プロパティ・マップの名前を指定します。
propName	config.xml内のマップからフェッチするプロパティの名前を指定します。

9.2.31.3 例

次のコマンドは、プロパティpropAを返します。

wls:/mydomain/serverConfig> getConfigPropertyMapEntry('serverconfig','mapA', 'propA')

9.2.32 getFederationListValueInMap

マップの中にネストされているリスト値を返すオンライン・コマンドです。

9.2.32.1 説明

このコマンドは、cot.xml内のマップの中にネストされているリスト値を返します。

9.2.32.2 構文

getFederationListValueInMap('providerID', 'mapName', 'listName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
mapName	プロパティ・マップの名前を指定します。
listName	マップからフェッチするリストの名前を指定します。

9.2.32.3 例

次のコマンドは、ネストされたリストmylistAを返します。

wls:/mydomain/serverConfig> getFederationListValueInMap('providerA','mymapA','mylistA')

9.2.33 getFederationMapEntryInMap

マップの中にネストされているマップ・プロパティ・エントリを返すオンライン・コマンドです。

9.2.33.1 説明

このコマンドは、cot.xml内のマップの中にネストされているマップ・プロパティ・エントリを返します。

9.2.33.2 構文

getFederationMapEntryInMap('providerID', 'mapname', 'nestedMapName', 'propName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
mapName	プロパティ・マップの名前を指定します。
nestedmapName	ネストされたプロパティ・マップの名前を指定します。
propName	ネストされたマップからフェッチするプロパティの名前を指定します。

9.2.33.3 例

次のコマンドは、プロパティ・エントリmyvarAを返します。

wls:/mydomain/serverConfig> getFederationMapEntryInMap('providerA','mymap','nestedmapA','myvarA')

9.2.34 getFederationProperty

プロパティ値を返すオンライン・コマンドです。

9.2.34.1 説明

このコマンドは、cot.xml内のプロパティ値を返します。

9.2.34.2 構文

getFederationProperty('providerID', 'propName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
propName	cot.xmlからフェッチするプロパティの名前を指定します。

9.2.34.3 例

次のコマンドは、プロパティmyvarAを返します。

wls:/mydomain/serverConfig> getFederationProperty('providerA','myvarA')

9.2.35 getFederationPropertyList

プロパティ・リストを返すオンライン・コマンドです。

9.2.35.1 説明

このコマンドは、cot.xml内のプロパティ・リストを返します。

9.2.35.2 構文

getFederationPropertyList('providerID', 'listName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
listName	マップからフェッチするリストの名前を指定します。

9.2.35.3 例

次のコマンドは、リストmylistAを返します。

wls:/mydomain/serverConfig> getFederationPropertyList('providerA','mylistA')

9.2.36 extractproviderprops

プロバイダのプロパティをエクスポートするスクリプト・コマンドです。

注意: これはスクリプト・コマンドです。オンラインのWLSTプロンプトから直接実行することはできません。Oracle Identity Federationのスクリプトは、$ORACLE_HOME/fed/scriptsにあります。

9.2.36.1 説明

指定したプロバイダのすべての構成プロパティを抽出して、それらをテキスト・ファイルにエクスポートするスクリプト・コマンドです。後でこのファイルを使用して、同じプロパティを別のプロバイダに設定できます。

9.2.36.2 構文

java weblogic.WLST extractproviderprops.py providerID filename 

引数	定義
providerID	プロパティを抽出するプロバイダの名前を指定します。
filename	プロバイダのプロパティを抽出するテキスト・ファイルの名前を指定します。

スクリプトの実行時に、WebLogic管理者資格証明書および接続URLの入力を求められます。接続URLには管理サーバーのポートではなく、管理対象サーバーのポートを指定してください。

ファイル・フォーマット

抽出ファイルの形式は次のとおりです。

TYPE:NAME:PROPNAME:PROPVALUE:PROPTYPE

次に例を示します。

X:X:sendattribute:false:boolean
MAP:attributelist/mailemail:datastore-attr:mail:string
LIST:sendattributefornameid:unspecified::string

9.2.37 setproviderprops

テキスト・ファイルの値を使用して、プロバイダのプロパティを設定するスクリプト・コマンドです。

注意: これはスクリプト・コマンドです。オンラインのWLSTプロンプトから直接実行することはできません。Oracle Identity Federationのスクリプトは、$ORACLE_HOME/fed/scriptsにあります。

9.2.37.1 説明

テキスト・ファイルの値を使用して、プロバイダのプロパティを設定するスクリプト・コマンドです。

テキスト・ファイルはextractproviderpropsコマンドで生成します。

9.2.37.2 Syntax

java weblogic.WLST setproviderprops.py providerID filename 

引数	定義
providerID	プロパティを更新するプロバイダの名前を指定します。
filename	プロパティを読み取る入力ファイルの名前を指定します。

スクリプトの実行時に、WebLogic管理者資格証明書および接続URLの入力を求められます。接続URLには管理サーバーのポートではなく、管理対象サーバーのポートを指定してください。

9.2.38 getFederationPropertyMapEntry

マップ内のプロパティ値を返すオンライン・コマンドです。

9.2.38.1 説明

このコマンドは、cot.xml内のマップからプロパティ値を返します。

9.2.38.2 構文

getFederationPropertyMapEntry('providerID', 'mapName', 'propName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
mapName	プロパティ・マップの名前を指定します。
propName	ネストされたマップからフェッチするプロパティの名前を指定します。

9.2.38.3 例

次のコマンドは、マップからプロパティpropAを返します。

wls:/mydomain/serverConfig> getFederationPropertyMapEntry('providerA','mapA', 'propA')

9.2.39 listCustomAuthnEngines

カスタム認証統合エンジンのリストを返すオンライン・コマンドです。

9.2.39.1 説明

このコマンドは、config.xmlからカスタム認証統合エンジンのリストを返します。

9.2.39.2 構文

listCustomAuthnEngines()

9.2.39.3 例

次のコマンドは、すべてのSPエンジンのリストを返します。

wls:/mydomain/serverConfig> listCustomAuthnEngines()

9.2.40 listCustomSPEngines

カスタムSP統合エンジンのリストを返すオンライン・コマンドです。

9.2.40.1 説明

このコマンドは、config.xmlからカスタム・サービス・プロバイダ(SP)統合エンジンのリストを返します。

9.2.40.2 構文

listCustomSPEngines()

9.2.40.3 例

次のコマンドは、すべてのSP統合エンジンのリストを返します。

wls:/mydomain/serverConfig> listCustomSPEngines()

9.2.41 loadMetadata

入力ファイルからメタデータをロードするオンライン・コマンドです。

9.2.41.1 説明

このコマンドは、入力ファイルからcot.xmlにメタデータをロードします。

9.2.41.2 構文

loadMetadata('metadatafile','description')

引数	定義
metadatafile	追加または更新するピア・プロバイダのメタデータを指定します。
description	ロードするピア・プロバイダの簡単な説明です。

9.2.41.3 例

次のコマンドは、ファイルmetadatafile.xmlからメタデータをロードします。

wls:/mydomain/serverConfig> loadMetadata('/home/metadatafile.xml','some description')

9.2.42 oifStatus

WLSTが接続している管理対象サーバーのOracle Identity Federationアプリケーションの現行のステータスを報告するオンライン・コマンドです。

9.2.42.1 説明

このコマンドは、管理対象サーバーのOracle Identity Federationの現行のステータスを表示します。

9.2.42.2 構文

oifStatus('serverurl', 'configfile', 'keyfile')

引数	定義
serverurl	管理対象サーバーのURLを指定します。
configfile	WLST storeUserConfigコマンドで作成された事前定義済のユーザー構成ファイルです。
keyfile	WLST storeUserConfigコマンドで作成された事前定義済のキー・ファイルです。

9.2.42.3 例

次のコマンドでは、引数が指定されていないため、WLSTによってOracle WebLogic Serverのユーザー名、パスワードおよび管理対象サーバーのURLを入力するよう求められ、入力後にフェデレーション・サーバーのステータスが表示されます。

wls:/mydomain/serverConfig> oifStatus()

次のコマンドでは、管理対象サーバーのURLのみが指定されているため、WLSTによってOracle WebLogic Serverのユーザー名とパスワードを入力するよう求められ、入力後にフェデレーション・サーバーのステータスが表示されます。

wls:/mydomain/serverConfig> oifStatus('', '', 't3://localhost:7499')

次のコマンドでは、WLSTに必要な引数がすべて指定されているため、フェデレーション・サーバーのステータスが表示されます。

wls:/mydomain/serverConfig> oifStatus('configfileA', 'keyfileB', 't3://localhost:7499')

9.2.43 removeConfigListInMap

マップの中にネストされているリスト・プロパティを削除するオンライン・コマンドです。

9.2.43.1 説明

このコマンドは、config.xml内のマップの中にネストされているリスト・プロパティを削除します。

9.2.43.2 構文

removeConfigListInMap('configName', 'mapName', 'listName')

引数	定義
configName	アクセスする構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	プロパティ・マップの名前を指定します。
listName	マップから削除するリストの名前を指定します。

9.2.43.3 例

次のコマンドは、リスト・プロパティmylistAを削除します。

wls:/mydomain/serverConfig> removeConfigListInMap('serverConfig','mymapA','mylistA')

9.2.44 removeConfigMapEntryInMap

マップの中にネストされているマップ・プロパティを削除するオンライン・コマンドです。

9.2.44.1 説明

このコマンドは、config.xml内のマップの中にネストされているマップ・プロパティ・エントリを削除します。

9.2.44.2 構文

oifStatus('serverurl', 'configfile', 'keyfile')

引数	定義
serverurl	アクセスする構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
configfile	プロパティ・マップの名前を指定します。
keyfile	ネストされたプロパティ・マップの名前を指定します。

9.2.44.3 例

次のコマンドは、ネストされたプロパティmyvarAを削除します。

wls:/mydomain/serverConfig> removeConfigMapEntryInMap('serverconfig','mymap','nestedmapA','myvarA')

9.2.45 removeConfigMapInMap

マップの中にネストされているマップ・プロパティを削除するオンライン・コマンドです。

9.2.45.1 説明

このコマンドは、config.xml内のマップの中にネストされているマップ・プロパティ・エントリを削除します。

9.2.45.2 構文

removeConfigMapEntryInMap('configName', 'mapname', 'nestedMapName', 'propName')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	プロパティ・マップの名前を指定します。
nestedmapName	ネストされたプロパティ・マップの名前を指定します。
propName	ネストされたマップから削除するプロパティの名前を指定します。

9.2.45.3 例

次のコマンドは、ネストされたプロパティmyvarAを削除します。

wls:/mydomain/serverConfig> removeConfigMapEntryInMap('serverconfig','mymap','nestedmapA','myvarA')

9.2.46 removeConfigProperty

構成プロパティを削除するオンライン・コマンドです。

9.2.46.1 説明

このコマンドは、config.xml内のプロパティを削除します。

9.2.46.2 構文

removeConfigProperty('configName', 'propName')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
propName	削除するプロパティの名前を指定します。

9.2.46.3 例

次のコマンドは、プロパティmyvarAを削除します。

wls:/mydomain/serverConfig> removeConfigProperty('serverconfig','myvarA')

9.2.47 removeConfigPropertyList

構成プロパティ・リストを削除するオンライン・コマンドです。

9.2.47.1 説明

このコマンドは、config.xml内のプロパティ・リストを削除します。

9.2.47.2 構文

removeConfigPropertyList('configName', 'listName')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
listName	削除するプロパティ・リストの名前を指定します。

9.2.47.3 例

次のコマンドは、プロパティ・リストmylistAを削除します。

wls:/mydomain/serverConfig> removeConfigPropertyList('serverconfig','mylistA')

9.2.48 removeConfigPropertyMap

プロパティ・マップを削除するオンライン・コマンドです。

9.2.48.1 説明

このコマンドは、config.xml内のプロパティ・マップを削除します。

9.2.48.2 構文

removeConfigPropertyMap('configName', 'mapName')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	削除するプロパティ・マップの名前を指定します。

9.2.48.3 例

次のコマンドは、mapAを削除します。

wls:/mydomain/serverConfig> removeConfigPropertyMap('serverconfig','mapA')

9.2.49 removeConfigPropertyMapEntry

マップからプロパティ値を削除するオンライン・コマンドです。

9.2.49.1 説明

このコマンドは、config.xml内のマップからプロパティ値を削除します。

9.2.49.2 構文

removeConfigPropertyMapEntry('configName', 'mapName', 'propName')

引数	定義
configName	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
mapName	更新するプロパティ・マップの名前を指定します。
propName	マップから削除するプロパティの名前を指定します。

9.2.49.3 例

次のコマンドは、プロパティpropAを削除します。

wls:/mydomain/serverConfig> removeConfigPropertyMapEntry('serverconfig','mapA', 'propA')

9.2.50 removeFederationListInMap

マップ内のプロパティ・リストを削除するオンライン・コマンドです。

9.2.50.1 説明

このコマンドは、cot.xml内のマップからプロパティ・リストを削除します。

9.2.50.2 構文

removeFederationListInMap('providerID', 'mapName', 'listName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
mapName	プロパティ・マップの名前を指定します。
listName	削除するプロパティ・リストの名前を指定します。

9.2.50.3 例

次のコマンドは、mymapAのmylistAを削除します。

wls:/mydomain/serverConfig> removeFederationListInMap('providerA','mymapA','mylistA')

9.2.51 removeFederationMapInMap

マップの中にネストされているマップを削除するオンライン・コマンドです。

9.2.51.1 説明

このコマンドは、cot.xml内のマップの中にネストされているプロパティ・マップを削除します。

9.2.51.2 構文

removeFederationMapInMap('providerID', 'mapname', 'nestedMapName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
mapName	ネストされたマップを含むプロパティ・マップの名前を指定します。
nestedmapName	削除するネストされたプロパティ・マップの名前を指定します。

9.2.51.3 例

次のコマンドは、mymapからnestedmapAを削除します。

wls:/mydomain/serverConfig> removeFederationMapInMap('providerA','mymap','nestedmapA')

9.2.52 removeFederationMapEntryInMap

マップの中にネストされているマップ・プロパティ・エントリをマップから削除するオンライン・コマンドです。

9.2.52.1 説明

このコマンドは、cot.xml内のマップの中にネストされているマップからプロパティ名/値ペアを削除します。

9.2.52.2 構文

removeFederationMapEntryInMap('providerID', 'mapname', 'nestedMapName', 'propName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
mapName	ネストされたマップを含むプロパティ・マップの名前を指定します。
nestedmapName	ネストされたプロパティ・マップの名前を指定します。
propName	ネストされたマップから削除するプロパティの名前を指定します。

9.2.52.3 例

次のコマンドは、マップ・プロパティ・エントリmyvarAを削除します。

wls:/mydomain/serverConfig> removeFederationMapEntryInMap('providerA','mymap','nestedmapA','myvarA')

9.2.53 removeFederationProperty

プロパティ値を削除するオンライン・コマンドです。

9.2.53.1 説明

このコマンドは、cot.xml内のプロパティ・エントリを削除します。

9.2.53.2 構文

removeFederationProperty('providerID', 'propName')

引数	定義
providerID	更新するピア・プロバイダの名前を指定します。
propName	削除するプロパティの名前を指定します。

9.2.53.3 例

次のコマンドは、プロバイダ・プロパティmyvarAを削除します。

wls:/mydomain/serverConfig> removeFederationProperty('providerA','myvarA')

9.2.54 removeFederationPropertyList

プロパティ・リスト・エントリを削除するオンライン・コマンドです。

9.2.54.1 説明

このコマンドは、cot.xml内のプロパティ・リスト・エントリを削除します。

9.2.54.2 構文

removeFederationPropertyList('providerID', 'listName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
listName	削除するプロパティ・リストの名前を指定します。

9.2.54.3 例

次のコマンドは、mylistAを削除します。

wls:/mydomain/serverConfig> removeFederationPropertyList('providerA','mylistA')

9.2.55 removeFederationPropertyMap

プロパティ・マップを削除するオンライン・コマンドです。

9.2.55.1 説明

このコマンドは、cot.xml内のプロパティ・マップを削除します。

9.2.55.2 構文

removeFederationPropertyMap('providerID', 'mapName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
mapName	削除するプロパティ・マップの名前を指定します。

9.2.55.3 例

次のコマンドは、マップを削除します。

wls:/mydomain/serverConfig> removeFederationPropertyMap('providerA','mapA')

9.2.56 removeFederationPropertyMapEntry

マップからプロパティ値を削除するオンライン・コマンドです。

9.2.56.1 説明

このコマンドは、cot.xmlのマップからプロパティ値を削除します。

9.2.56.2 構文

removeFederationPropertyMapEntry('providerID', 'mapName', 'propName')

引数	定義
providerID	アクセスするピア・プロバイダの名前を指定します。
mapName	更新するプロパティ・マップの名前を指定します。
propName	マップから削除するプロパティの名前を指定します。

9.2.56.3 例

次のコマンドは、マップからプロパティpropAを削除します。

wls:/mydomain/serverConfig> removeFederationPropertyMapEntry('providerA','mapA', 'propA')

9.2.57 removePeerProviderEntry

ピア・プロバイダ・エントリを削除するオンライン・コマンドです。

9.2.57.1 説明

このコマンドは、cot.xmlからピア・プロバイダ・エントリを削除します。

9.2.57.2 構文

removePeerProviderEntry('providerID')

引数	定義
providerID	削除するピア・プロバイダの名前を指定します。

9.2.57.3 例

次のコマンドは、providerAを削除します。

wls:/mydomain/serverConfig> removePeerProviderEntry('providerA')

9.2.58 setConfigProperty

config.xmlにプロパティ値を設定するオンライン・コマンドです。

9.2.58.1 説明

このコマンドは、config.xmlにプロパティ値を追加、またはconfig.xmlのプロパティ値を更新します。

9.2.58.2 構文

setConfigProperty('configname', 'propName', 'value', 'type')

引数	定義
configname	更新する構成の名前(idpsaml20、serverconfig、spsaml20など)を指定します。
propname	config.xmlに追加/更新するプロパティの名前を指定します。
value	プロパティ値を指定します。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.58.3 例

次のコマンドは、プロパティmyvarAとその値をサーバー構成に設定します。

wls:/mydomain/serverConfig> setConfigProperty('serverconfig','myvarA','myvalA','string')

9.2.59 setCustomAuthnEngine

カスタム認証統合エンジンを更新するオンライン・コマンドです。

9.2.59.1 説明

このコマンドは、config.xml内のカスタム認証統合エンジンを更新します。

9.2.59.2 構文

setCustomAuthnEngine('engineID', 'name', 'enabled', 'webContext', 'authnRelativePath', 'logoutRelativePath', 'logoutEnabled')

引数	定義
engineID	既存のエンジンのエンジンIDを指定します。
name	カスタム・エンジンの名前を指定します。
enabled	このフラグには、エンジンを有効にする(true)か、無効にする(false)かを指定します。
webContext	エンジンのWebコンテキストを指定します。
authnRelativePath	エンジンの認証相対パスURLを指定します。
logoutRelativePath	エンジンのログアウト相対パスURLを指定します。
logoutEnabled	このフラグは、エンジンのログアウトを有効にする場合はtrueに設定します。それ以外の場合はfalseに設定します。

9.2.59.3 例

次のコマンドは、カスタム認証エンジンabcdefの構成を更新します。

wls:/mydomain/serverConfig> setCustomAuthnEngine('abcdef',
'custom one','false','oracle:fed:authentication:unspecified','webcontext')

9.2.60 setCustomSPEngine

カスタムSP統合エンジンを更新するオンライン・コマンドです。

9.2.60.1 説明

このコマンドは、config.xml内の既存のカスタムSP統合エンジンを更新します。

9.2.60.2 構文

setCustomSPEngine('engineID' ,'name', 'enabled', 'authnMech', 'webContext', 'authnRelativePath', 'logoutRelativePath', 'logoutEnabled')

引数	定義
engineID	既存のカスタム・エンジンのエンジンIDを指定します。
name	カスタム・エンジンの名前を指定します。
enabled	このフラグには、エンジンを有効にする(true)か、無効にする(false)かを指定します。
authnMech	エンジンの認証メカニズムを指定します。
webContext	エンジンのWebコンテキストを指定します。
authnRelativePath	エンジンの認証相対パスURLを指定します。
logoutRelativePath	エンジンのログアウト相対パスURLを指定します。
logoutEnabled	このフラグは、エンジンのログアウトを有効にする場合はtrueに設定します。それ以外の場合はfalseに設定します。

9.2.60.3 例

次のコマンドは、engineID2というIDのエンジンに名前と有効フラグを設定します。

wls:/mydomain/serverConfig> setCustomSPEngine('engineid2','test','true')

9.2.61 setFederationProperty

プロパティ値を追加または更新するオンライン・コマンドです。

9.2.61.1 説明

このコマンドは、cot.xmlにプロパティ値を追加、またはcot.xml内の既存のエントリを更新します。

9.2.61.2 構文

setFederationProperty('providerID', 'propName', 'value', 'type')

引数	定義
providerID	更新するピア・プロバイダの名前を指定します。
propname	cot.xmlに追加/更新するプロパティの名前を指定します。
value	プロパティ値を指定します。
type	プロパティの型(BOOLEAN、STRINGまたはLONG)を指定します。

9.2.61.3 例

次のコマンドは、プロパティmyvarAを作成し、その値を設定します。

wls:/mydomain/serverConfig> setFederationProperty('providerA','myvarA','myvalA','string')