4 インフラストラクチャ・セキュリティ・カスタムWLSTコマンド

この章では、インフラストラクチャ・セキュリティ用のカスタムWLSTコマンド、およびそのコマンド構文、引数、コマンド例を詳細に説明します。

注意: IDM 11gR2リリースをインストールした場合、サポートされているWLSTコマンドについては、使用するリリースに対応するOracleオンライン・ライブラリで、適切なWLSTコマンド・リファレンスを参照してください。PS3より前のIDM 11gR2リリースの場合は、『WebLogic Scripting Toolコマンド・リファレンス』の「インフラストラクチャ・セキュリティ・カスタムWLSTコマンド」を参照してください。IDM 11gR2 PS3以降のリリースの場合、アイデンティティとアクセス権の管理の詳細は、『WebLogic Scripting Toolコマンド・リファレンス』を参照してください。

次の項では、Oracle Fusion Middleware Infrastructure SecurityカスタムWLSTコマンドについて説明します。次のトピックがあります。

• 4.1項「WLSTセキュリティ・コマンドの概要」

• 4.2項「監査設定コマンド」

• 4.3項「SSL構成コマンド」

• 4.4項「Oracle Identity Federationのコマンド」

• 4.5項「ディレクトリ統合プラットフォーム・コマンド」

• 4.6項「セキュリティ・コマンド」

• 4.7項「Oracle Access Managerコマンド」

• 4.8項「Oracle Security Token Service」

• 4.9項「Oracleキーストア・サービス」

• 4.10項「Library Oracle Virtual Directory (libOVD)コマンド」

• 4.11項「アイデンティティ・ディレクトリ・サービス・コマンド」

Oracle Platform Security Servicesの詳細は、『Oracle Fusion Middlewareアプリケーション・セキュリティ・ガイド』を参照してください。

注意: インフラストラクチャ・セキュリティ・カスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

4.1 WLSTセキュリティ・コマンドの概要

WLSTセキュリティ・コマンドは次のカテゴリに分かれています。

表4-1 WLSTコマンド・カテゴリ

コマンド・カテゴリ	説明
監査設定コマンド	監査ポリシーおよび監査リポジトリ設定を表示し管理します
SSL設定コマンド	Oracle HTTP Server、Oracle WebCache、Oracleインターネット・ディレクトリおよびOracle仮想ディレクトリ・コンポーネントのウォレット、JKSキーストアおよびSSL設定を表示し管理します。
Oracle ID連合コマンド	Oracle ID連合の設定を表示し管理します。
ディレクトリ統合プラットフォーム・コマンド	DIPツールの詳細は、Oracle Fusion Middleware Oracle Identity Managementリファレンスのディレクトリ統合プラットフォーム・ツールに関する項を参照してください。
セキュリティ・コマンド	ドメインおよび資格証明ドメイン・ストアを管理し、ドメイン・ポリシー・ストアを移動します。
Oracle Access Managerコマンド	認可プロバイダ、アイデンティティ・アサーション・プロバイダ、SSOプロバイダなど、OAM関連コンポーネントを管理します。
Library Oracle Virtual Directory (libOVD)コマンド	特定のOPSSコンテキストに関連付けられているLibrary Oracle Virtual Directory (libOVD)構成を表示および管理します。
アイデンティティ・ディレクトリ・サービス・コマンド	アイデンティティ・ディレクトリ・サービスのエンティティ属性、エンティティ定義、関係およびデフォルトの操作構成を管理します。

4.2 監査構成コマンド

表4-2に表示されているWLSTコマンドを使用して、監査ポリシーおよび監査リポジトリ設定を表示し管理します。

表4-2 WLST監査コマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
getNonJavaEEAuditMBeanName	Java EE以外のコンポーネントのmBean名を表示します。	オンライン
getAuditPolicy	監査ポリシー設定を表示します。	オンライン
setAuditPolicy	監査ポリシー設定を更新します。	オンライン
getAuditRepository	監査リポジトリ設定を表示します。	オンライン
setAuditRepository	監査リポジトリ設定を更新します。	オンライン
listAuditEvents	1つ またはすべてのコンポーネントの監査イベントを表示します。	オンライン
exportAuditConfig	コンポーネントの監査設定をエクスポートします。	オンライン
importAuditConfig	コンポーネントの監査設定をインポートします。	オンライン
createAuditDBView	データベースに監査定義ビューを作成します。	オンライン
listAuditComponents	監査可能なコンポーネントを一覧表示します。	オンライン
registerAudit	指定したコンポーネントの監査定義を監査ストアに登録します。	オンライン
deregisterAudit	指定したコンポーネントの監査定義を監査ストアから削除します。	オンライン

詳細は、『Oracle Fusion Middlewareアプリケーション・セキュリティ・ガイド』を参照してください。

4.2.1 getNonJavaEEAuditMBeanName

Java EE以外のコンポーネントのmbean名を表示するオンライン・コマンドを示します。

4.2.1.1 説明

このコマンドは、インスタンス名、コンポーネント名、コンポーネントのタイプおよびコンポーネントの監査mbeanが実行しているOracle WebLogic Serverを指定したJava EE以外のコンポーネントのmbean名を表示します。mbeanは、Java EE以外のコンポーネントを管理するときに別の監査WLSTコマンドに対して必要なパラメータです。

4.2.1.2 構文

getNonJavaEEAuditMBeanName(instName, compName, compType, svrName)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、ohs、oid、ovdおよびWebCache。
svrName	Oracle WebLogic Serverの名前を指定します。

4.2.1.3 例

次の対話型コマンドは、Oracleインターネット・ディレクトリのmBean名を表示します。

wls:/mydomain/serverConfig> getNonJavaEEAuditMBeanName(instName='inst1', compName='oid1', compType='oid', svrName='AdminServer')

4.2.2 getAuditPolicy

監査ポリシー設定を表示するオンライン・コマンドを示します。

4.2.2.1 説明

このコマンドは、フィルタの事前設定、特定ユーザー、カスタム・イベント、ログ・ファイルの最大サイズおよびログ・ディレクトリの最大サイズを含む監査ポリシー設定を表示します。mbeanコンポーネントは、Oracleインターネット・ディレクトリおよびOracle仮想ディレクトリなどJava EE以外のコンポーネントに必要です。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

4.2.2.2 構文

getAuditPolicy([mbeanName, componentType])

引数	定義
mbeanName	Java EE以外のコンポーネントに対してコンポーネント監査MBeanの名前を指定します。
componentType	監査ストアに登録されている特定のコンポーネントの監査ポリシーを要求します。指定しない場合、jps-config.xml内の監査ポリシーが戻されます。

4.2.2.3 例

次のコマンドは、Java EEコンポーネントの監査設定を表示します。

wls:/mydomain/serverConfig> getAuditPolicy()
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean as the root.
For more help, use help(domainRuntime)
 
FilterPreset:All
Max Log File Size:104857600
Max Log Dir Size:0

次のコマンドは、MBean CSAuditProxyMBeanの監査設定を表示します。

wls:/mydomain/serverConfig> getAuditPolicy(on='oracle.security.audit.test:type=CSAuditMBean,
name=CSAuditProxyMBean')

4.2.3 setAuditPolicy

監査ポリシーを更新するオンライン・コマンドを示します。

4.2.3.1 説明

監査ポリシー設定を行うオンライン・コマンドを示します。フィルタの事前設定、ユーザーの追加/削除およびカスタム・イベントの追加/削除を行うことができます。mbeanコンポーネントは、Oracleインターネット・ディレクトリおよびOracle仮想ディレクトリなどJava EE以外のコンポーネントに必要です。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

4.2.3.2 構文

setAuditPolicy([mbeanName],[filterPreset],[addSpecialUsers],
[removeSpecialUsers],[addCustomEvents],[removeCustomEvents], [componentType], [maxDirSize], [maxFileSize], [andCriteria], [orCriteria], [componentEventsFile])

引数	定義
mbeanName	Java EE以外のコンポーネントに対してコンポーネント監査MBeanの名前を指定します。
filterPreset	フィルタの変更する事前設定を指定します。
addSpecialUsers	追加する特定ユーザーを指定します。
removeSpecialUsers	削除する特定ユーザーを指定します。
addCustomEvents	追加するカスタム・イベントを指定します。
removeCustomEvents	削除するカスタム・イベントを指定します。
componentType	更新するコンポーネント定義タイプを指定します。指定しない場合、jps-config.xmlに定義されている監査設定が変更されます。
maxDirSize	ログ・ディレクトリの最大サイズを指定します。
maxFileSize	ログ・ファイルの最大サイズを指定します。
andCriteria	事前定義済のカスタム・フィルタ定義においてand条件を指定します。
orCriteria	事前定義済のカスタム・フィルタ定義においてor条件を指定します。
componentEventsFile	11gリリース1 (11.1.1.6)のメタデータ・モデルのコンポーネント定義ファイルを指定します。11gリリース1 (11.1.1.6)メタデータ・モデル・コンポーネントの監査ストア内の監査ポリシーを作成/更新する場合、フィルタの事前定義済レベルがCustomに設定されているときは、このパラメータが必要です。

4.2.3.3 例

次の対話型コマンドは、監査ポリシーをNoneレベルに設定し、ポリシーからuser1を削除するときに、user2およびuser3を追加します。

wls:/mydomain/serverConfig> setAuditPolicy (filterPreset=
'None',addSpecialUsers='user2,user3',removeSpecialUsers='user1')

wls:/mydomain/serverConfig> getAuditPolicy();
Already in Domain Runtime Tree

FilterPreset:None
Special Users:user2,user3
Max Log File Size:104857600
Max Log Dir Size:0

次の対話型コマンドは、ポリシーからログアウト・イベントを削除するときに、ログイン・イベントを追加します。

wls:/mydomain/serverConfig> setAuditPolicy(filterPreset=
'Custom',addCustomEvents='UserLogin',removeCustomEvents='UserLogout')
 

次の対話型コマンドは、監査ポリシーをLowレベルに設定します。

wls:/IDMDomain/domainRuntime> setAuditPolicy(filterPreset='Low');
Already in Domain Runtime Tree
Audit Policy Information updated successfully

wls:/IDMDomain/domainRuntime> getAuditPolicy();
Already in Domain Runtime Tree
FilterPreset:Low
Max Log File Size:104857600
Max Log Dir Size:0

次のコマンドは、カスタム・フィルタを設定して、CheckAuthorizationイベントを監査します。

wls:/IDMDomain/domainRuntime> setAuditPolicy(filterPreset='Custom', addCustomEvents='JPS:CheckAuthorization');
Already in Domain Runtime Tree
 
Audit Policy Information updated successfully
wls:/IDMDomain/domainRuntime> getAuditPolicy();
Already in Domain Runtime Tree
 
FilterPreset:Custom
Special Users:user1
Max Log File Size:104857600
Max Log Dir Size:0
Custom Events:JPS:CheckAuthorization

4.2.4 getAuditRepository

監査リポジトリ設定を表示するオンライン・コマンドを示します。

4.2.4.1 説明

このコマンドは、Java EEコンポーネントおよびアプリケーション(Oracleインターネット・ディレクトリなどその他のコンポーネントの場合は、リポジトリ設定は、opmn.xmlに存在しています)の監査リポジトリ設定を表示します。また、リポジトリはデータベース型の場合、データベース設定を表示します。

4.2.4.2 構文

getAuditRepository 

4.2.4.3 例

次のコマンドは、監査リポジトリ設定を表示します。

wls:/IDMDomain/domainRuntime> getAuditRepository()
Already in Domain Runtime Tree
 
Repository Type:File

4.2.5 setAuditRepository

監査リポジトリ設定を更新するオンライン・コマンドを示します。

4.2.5.1 説明

このコマンドは、Java EEコンポーネントおよびアプリケーション(Oracleインターネット・ディレクトリなどその他のコンポーネントの場合は、リポジトリが、opmn.xmlを編集して設定されます)の監査リポジトリ設定を設定します。

4.2.5.2 構文

setAuditRepository([switchToDB],[dataSourceName],[interval])

引数	定義
switchToDB	trueの場合、リポジトリをファイルからデータベースに切り替えます。
dataSourceName	データ・ソースの名前を指定します。
interval	監査ローダーのキックオフ間隔を指定します。

4.2.5.3 例

次のコマンドは、ファイル・リポジトリからデータベース・リポジトリに切り替えます。

wls:/IDMDomain/domainRuntime> setAuditRepository(switchToDB='true');
Already in Domain Runtime Tree
 
Audit Repository Information updated
 
wls:/IDMDomain/domainRuntime> getAuditRepository();
Already in Domain Runtime Tree
 
JNDI Name:jdbc/AuditDB
Interval:15
Repository Type:DB

次の対話型のコマンドは、監査リポジトリを特定のデータベースに変更し、監査ローダー間隔を14秒に設定します。

wls:/mydomain/serverConfig> setAuditRepository(switchToDB='true',dataSourceName='jdbcAuditDB',interval='14')

4.2.6 listAuditEvents

コマンドの監査イベントを表示するオンライン・コマンドを示します。

4.2.6.1 説明

このコマンドは、コンポーネントの監査イベントおよび属性を表示します。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。コンポーネントのタイプを除いて、すべてのコンポーネントに対して適用するすべての一般的な属性が表示されます。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

4.2.6.2 構文

listAuditEvents([mbeanName],[componentType])

引数	定義
mbeanName	コンポーネントMBeanの名前を指定します。
componentType	コンポーネント・タイプを指定します。リストに表示される情報は、そのコンポーネント・タイプのすべてのイベントに限定されます。

4.2.6.3 例

次のコマンドは、Oracle Platform Security Servicesコンポーネントの監査イベントを表示します。

wls:/IDMDomain/domainRuntime> listAuditEvents(componentType='JPS');
Already in Domain Runtime Tree
 
Common Attributes
ComponentType
Type of the component. For MAS integrated SystemComponents this is the componentType
InstanceId
Name of the MAS Instance, that this component belongs to
HostId
DNS hostname of originating host
HostNwaddr
IP or other network address of originating host
ModuleId
ID of the module that originated the message. Interpretation is unique within Component ID.
ProcessId
ID of the process that originated the message

次のコマンドは、Oracle HTTP Serverの監査イベントを表示します。

wls:/mydomain/serverConfig> listAuditEvents(componentType='ohs')

次のコマンドは、すべての監査イベントを表示します。

wls:/IDMDomain/domainRuntime> listAuditEvents();
Already in Domain Runtime Tree
 
Components:
DIP
JPS
OIF
OWSM-AGENT
OWSM-PM-EJB
ReportsServer
WS-PolicyAttachment
WebCache
WebServices
Attributes applicable to all components:
ComponentType
InstanceId
HostId
HostNwaddr
ModuleId
ProcessId
OracleHome
HomeInstance
ECID
RID
...

4.2.7 exportAuditConfig

コンポーネントの監査設定をエクスポートするオンライン・コマンドを示します。

4.2.7.1 説明

このコマンドは、監査設定をファイルにエクスポートします。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

4.2.7.2 構文

exportAuditConfig([mbeanName],fileName, [componentType])

引数	定義
mbeanName	Java EE以外のコンポーネントのMBean名を指定します。
fileName	監査設定をエクスポートする必要があるパスおよびファイル名を指定します。
componentType	特定のコンポーネントのイベントのみをファイルにエクスポートすることを指定します。指定しない場合、jps-config.xml内の監査設定がエクスポートされます。

4.2.7.3 例

次の対話型のコマンドは、コンポーネントの監査設定をエクスポートします。

wls:/mydomain/serverConfig> exportAuditConfig(on='oracle.security.audit.test:type=CSAuditMBean,
name=CSAuditProxyMBean',fileName='/tmp/auditconfig')

次の対話型のコマンドは、Java EEコンポーネントの監査設定をエクスポートします。mBeanは指定されていません。

wls:/mydomain/serverConfig> exportAuditConfig(fileName='/tmp/auditconfig')

4.2.8 importAuditConfig

コンポーネントの監査設定をインポートするオンライン・コマンドを示します。

4.2.8.1 説明

このコマンドは、外部ファイルから監査設定をインポートします。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

4.2.8.2 構文

importAuditConfig([mbeanName],fileName, [componentType])

引数	定義
mbeanName	Java EE以外のコンポーネントのMBean名を指定します。
fileName	監査設定をインポートする必要があるパスおよびファイル名を指定します。
componentType	特定のコンポーネントのイベントのみをファイルからインポートすることを指定します。指定しない場合、jps-config.xml内の監査設定がインポートされます。

4.2.8.3 例

次の対話型のコマンドは、コンポーネントの監査設定をインポートします。

wls:/mydomain/serverConfig> importAuditConfig(on='oracle.security.audit.test:type=CSAuditMBean,
name='CSAuditProxyMBean',fileName='/tmp/auditconfig')

次の対話型のコマンドは、ファイルから監査設定をインポートします。mBeanは指定されていません。

wls:/mydomain/serverConfig> importAuditConfig(fileName='/tmp/auditconfig')

4.2.9 createAuditDBView

データベースで監査のビューを生成できるSQLスクリプトを作成します。

4.2.9.1 説明

このコマンドは、指定したコンポーネントの監査定義のデータベース・ビューを作成するために使用するSQLスクリプトを生成します。スクリプトは指定したファイルに書き込まれるとともに、コンソールに出力されます。

SQLスクリプトを実行すると、サイトの監査モデルに応じて次のように結果になります。

• 11.1.1.6.0モデルを使用していて、コンポーネントが監査ストアに登録されている場合、スクリプトは、指定したコンポーネントのシステム・コンポーネント表(IAU_COMMON、IAU_USERSESSION、IAU_AUDITSERVICEおよびIAU_CUSTOM)を使用してビューを作成します。

• 11.1.1.6.0より前のモデルを使用していて、コンポーネントは監査ストアに登録されていないが、イベント定義はcomponent_events.xmlファイル(oracle_common/modules/oracle.iau_11.1.1/components/<componentType>ディレクトリ内)にある場合、IAU_BASEおよびコンポーネント表を使用してビューが作成されます。

4.2.9.2 構文

createAuditDBView(fileName, componentType)

引数	定義
fileName	SQLスクリプトが書き込まれるパスとファイル名を指定します。
componentType	定義がビューの基礎となるコンポーネントです。

4.2.9.3 例

wls:/mydomain/serverConfig> 
createAuditDBView(fileName="/tmp/JPSAuditView.sql", componentType="JPS")

4.2.10 listAuditComponents

監査可能なコンポーネントを一覧表示します。

4.2.10.1 説明

このコマンドは、監査可能なコンポーネントのリストを作成します。11.1.1.6.0モデルおよび11.1.1.6.0より前のモデルを使用する監査ストアに登録されたコンポーネントを一覧表示します。

4.2.10.2 構文

listAuditComponents(fileName)

引数	定義
fileName	出力が書き込まれるパスとファイル名を指定します。

4.2.10.3 例

listAuditComponents(fileName = "/tmp/complist.txt")

4.2.11 registerAudit

指定したコンポーネントを監査ストアに登録します。

4.2.11.1 説明

指定したコンポーネントのイベント定義および変換コンテンツを監査ストアに追加します。11.1.1.6.0より前の監査XMLスキーマ定義を使用して登録しようとすると、11.1.1.6.0 XMLスキーマ定義にアップグレードされてから監査ストアに登録されます。

4.2.11.2 構文

registerAudit(xmlFile, [xlfFile], componentType, [mode=OVERWRITE|UPGRADE])

引数	定義
xmlFile	コンポーネント・イベント定義ファイルを指定します。
xlfFile	component xlf jarファイルを指定します。オプション。
componentType	登録するコンポーネントを指定します。
mode	OVERWRITEまたはUPGRADE。デフォルトはUPGRADEです。

4.2.11.3 例

wls:/mydomain/serverConfig>registerAudit(xmlFile="/tmp/comp.xml", 
xmlFile="/tmp/comp_xlf.jar", componentType="AuditApp", mode="UPGRADE")

4.2.12 deregisterAudit

指定したコンポーネントのイベント定義および変換コンテンツを監査ストアから削除します。

4.2.12.1 説明

指定したコンポーネントの既存のイベント定義および変換コンテンツまたはアプリケーションを監査ストアから削除します。

4.2.12.2 構文

deregisterAudit(componentType)

引数	定義
componentType	定義を削除するコンポーネントを指定します。

4.2.12.3 例

deregisterAudit(componentType="AuditApp")

4.3 SSL設定コマンド

表4-3に指定されているコマンドを使用して、Oracle Fusion MiddlewareコンポーネントのSSL設定を表示し管理します。

表4-3 SSL設定のWLSTコマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
addCertificateRequest	Oracleウォレットで証明書署名用要求を生成します。	オンライン
addSelfSignedCertificate	Oracleウォレットに自己署名証明書を追加します。	オンライン
changeKeyStorePassword	JKSキーストアへのパスワードを変更します。	オンライン
changeWalletPassword	Oracleウォレットへのパスワードを変更します。	オンライン
configureSSL	コンポーネント・リスナーのSSL属性を設定します。	オンライン
createKeyStore	JKSキーストアを作成します。	オンライン
createWallet	Oracleウォレットを作成します。	オンライン
deleteKeyStore	JKSキーストアを削除します。	オンライン
deleteWallet	Oracleウォレットを削除します。	オンライン
exportKeyStore	JKSキーストアをファイルにエクスポートします。	オンライン
exportKeyStoreObject	オブジェクトをJKSキーストアからファイルにエクスポートします。	オンライン
exportWallet	Oracleウォレットをファイルにエクスポートします。	オンライン
exportWalletObject	オブジェクトをOracleウォレットからファイルにエクスポートします。	オンライン
generateKey	JKSキーストアに鍵ペアを生成します。	オンライン
getKeyStoreObject	JKSキーストアに存在する証明書またはその他のオブジェクトを表示します。	オンライン
getSSL	コンポーネント・リスナーのSSL属性を表示します。	オンライン
getWalletObject	Oracleウォレットに存在する証明書またはその他のオブジェクトを表示します。	オンライン
importKeyStore	JKSキーストアをファイルからインポートします。	オンライン
importKeyStoreObject	証明書またはその他のオブジェクトをファイルからJKSキーストアにインポートします。	オンライン
importWallet	Oracleウォレットをファイルからインポートします。	オンライン
importWalletObject	証明書またはその他のオブジェクトをファイルからOracleウォレットにインポートします。	オンライン
listKeyStoreObjects	JKSキーストア内のすべてのオブジェクトを指定します。	オンライン
listKeyStores	コンポーネントのインスタンスに対して設定したすべてのJKSキーストアを指定します。	オンライン
listWalletObjects	Oracleウォレット内のすべてのオブジェクトを指定します。	オンライン
listWallets	コンポーネントのインスタンスに対して設定したすべてのOracleウォレットを指定します。	オンライン
removeKeyStoreObject	コンポーネントのインスタンスのJKSキーストアから証明者またはその他のオブジェクトを削除します。	オンライン
removeWalletObject	コンポーネントのインスタンスのOracleウォレットから証明者またはその他のオブジェクトを削除します。	オンライン

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

4.3.1 addCertificateRequest

Oracleウォレットに証明書署名要求を生成するオンライン・コマンドを示します。

4.3.1.1 説明

このコマンドは、コンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対してOracleウォレットにBase64暗号化されたPKCS#10フォーマットで証明書署名要求を生成します。承認された認証局(CA)によって証明書を署名するには、CAに証明書署名要求を送信します。

4.3.1.2 構文

addCertificateRequest(instName, compName, compType, walletName, password, DN, keySize)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。
walletName	ウォレット・ファイルの名前を指定します。
password	ウォレットのパスワードを指定します。
DN	鍵ペア・エントリの識別された名前を指定します。
keySize	キーのサイズをビットの単位で指定します。

4.3.1.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.acme.comおよびキーのサイズとして1024を指定した証明書署名要求を生成します。

wls:/mydomain/serverConfig> addCertificateRequest('inst1', 'oid1', 'oid','wallet1', 'password', 'cn=www.acme.com', '1024')

4.3.2 addSelfSignedCertificate

自己署名証明書を追加するオンライン・コマンドを示します。

4.3.2.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対して鍵ペアを作成し、Oracleウォレット内の自己署名証明書にラップします。RSAアルゴリズムに基づくキーのみ生成されます。

4.3.2.2 構文

addSelfSignedCertificate(instName, compName, compType, walletName, password, DN, keySize)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。
walletName	ウォレット・ファイルの名前を指定します。
password	ウォレットのパスワードを指定します。
DN	鍵ペア・エントリの識別された名前を指定します。
keySize	キーのサイズをビットの単位で指定します。

4.3.2.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.acme.comおよびキーのサイズとして1024を指定した自己署名証明書を生成します。

wls:/mydomain/serverConfig> addSelfSignedCertificate('inst1', 'oid1', 'oid','wallet1', 'password', 'cn=www.acme.com', '1024')

4.3.3 changeKeyStorePassword

キーストアのパスワードを変更するオンライン・コマンドを示します。

4.3.3.1 説明

このコマンドは、Oracle仮想ディレクトリ・インスタンスのJavaキーストア(JKS)のパスワードを変更します。

4.3.3.2 構文

changeKeyStorePassword(instName, compName, compType, keystoreName, currPassword, newPassword)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	キーストアのファイル名を指定します。
currPassword	キーストアの現在のパスワードを指定します。
newPassword	キーストアの新しいパスワードを指定します。

4.3.3.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してファイルkeys.jksのパスワードを変更します。

wls:/mydomain/serverConfig> changeKeyStorePassword('inst1', 'ovd1', 'ovd','keys.jks', 'currpassword', 'newpassword')

4.3.4 changeWalletPassword

Oracleウォレットのパスワードを変更するオンライン・コマンドを示します。

4.3.4.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)のOracleウォレットのパスワードを変更します。このコマンドは、パスワードが保護したウォレットに対してのみ適用されます。

4.3.4.2 構文

changeWalletPassword(instName, compName, compType, walletName,currPassword, newPassword)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「oid」、「ohs」および「webcache」です。
walletName	ウォレットのファイル名を指定します。
currPassword	ウォレットの現在のパスワードを指定します。
newPassword	ウォレットの新しいパスワードを指定します。

4.3.4.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle HTTP Serverインスタンスohs1に対してwallet1のパスワードをcurrpasswordからnewpasswordに変更します。

wls:/mydomain/serverConfig> changeWalletPassword('inst1', 'ohs1', 'ohs','wallet1', 'currpassword', 'newpassword')

4.3.5 configureSSL

SSLの属性を設定するオンライン・コマンドを示します。

4.3.5.1 説明

このコマンドは、コンポーネント・リスナーのSSL属性を設定します。属性は、プロパティ・ファイル・フォーマット(name=value)で指定されています。プロパティ・ファイルを提供しない場合またはプロパティ・ファイルにSSLの属性 が含まれていない場合、デフォルトの属性値が使用されます。コンポーネントに特有のSSL属性のデフォルト値については、Oracle Fusion Middleware管理者ガイドの章「Oracle Fusion Middleware内のSSLの設定」を参照してください。

4.3.5.2 構文

configureSSL(instName, compName, compType, listener, filePath)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「oid」、「ovd」、「ohs」および「webcache」です。
リスナー	SSLに対して設定するコンポーネント・リスナーの名前を示します。
filePath	設定するSSL属性を含むプロパティ・ファイルの絶対パスを指定します。

4.3.5.3 例

次のコマンドは、リスナーlistener1に対してアプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1のプロパティ・ファイル/tmp/ssl.propertiesに指定したSSLの属性を設定します。

wls:/mydomain/serverConfig> configureSSL('inst1', 'ovd1', 'ovd', 'listener1','/tmp/ssl.properties')

次のコマンドは、プロパティ・ファイルを指定せずにSSLの属性を設定します。ファイルは何も指定していないので、SSL属性のデフォルト値が使用されます。

wls:/mydomain/serverConfig> configureSSL('inst1', 'ovd1', 'ovd', 'listener2')

4.3.6 createKeyStore

JKSキーストアを作成するオンライン・コマンドを示します。

4.3.6.1 説明

このコマンドは、指定したOracle仮想ディレクトリ・インスタンスのJavaキーストア(JKS)を作成します。キーストア・ファイルの場所およびその他の情報については、Oracle Fusion Middleware管理者ガイドの章「キーストア、ウォレットおよび証明書の管理」を参照してください。

4.3.6.2 構文

createKeyStore(instName, compName, compType, keystoreName, password)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	作成するキーストア・ファイルの名前を示します。
password	キーストアのパスワードを指定します。

4.3.6.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1のパスワードとしてpasswordを指定したJKSファイルkeys.jksを作成します。

wls:/mydomain/serverConfig> createKeyStore('inst1', 'ovd1', 'ovd','keys.jks', 'password')

4.3.7 createWallet

Oracleウォレットを作成するオンライン・コマンドを示します。

4.3.7.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)のOracleウォレットを作成します。ウォレットは、パスワード保護したまたは自動ログイン・タイプ をとることができます。ウォレットの情報については、Oracle Fusion Middleware管理者ガイドの章「キーストア、ウォレットおよび証明書の管理」を参照してください。

4.3.7.2 構文

createWallet(instName, compName, compType, walletName, password)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「oid」、「ohs」および「webcache」です。
walletName	作成するウォレット・ファイルの名前を示します。
password	ウォレットのパスワードを指定します。

4.3.7.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle HTTP Serverインスタンスohs1に対してパスワードとしてpasswordを指定したwallet1という名前のウォレットを作成します。

wls:/mydomain/serverConfig> createWallet('inst1', 'ohs1', 'ohs','wallet1', 'password')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle WebCacheインスタンスのwc1に対してwallet2という名前の自動ログイン・ウォレットを作成します。

wls:/mydomain/serverConfig> createWallet('inst1', 'wc1', 'webcache','wallet2', '')

4.3.8 deleteKeyStore

キーストアを削除するオンライン・コマンドを示します。

4.3.8.1 説明

このコマンドは、指定したOracle仮想ディレクトリ・インスタンスのキーストアを削除します。

4.3.8.2 構文

deleteKeyStore(instName, compName, compType, keystoreName)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	削除するキーストア・ファイルの名前を指定します。

4.3.8.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1のJKSファイルkeys.jksを削除します。

wls:/mydomain/serverConfig> deleteKeyStore('inst1', 'ovd1', 'ovd','keys.jks')

4.3.9 deleteWallet

Oracleウォレットを削除するオンライン・コマンドを示します。

4.3.9.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)のOracleウォレットを削除します。

4.3.9.2 構文

deleteWallet(instName, compName, compType, walletName)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「oid」、「ohs」および「webcache」です。
walletName	削除するウォレット・ファイルの名前を示します。

4.3.9.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle HTTP Serverインスタンスohs1に対してwallet1という名前のウォレットを削除します。

wls:/mydomain/serverConfig> deleteWallet('inst1', 'ohs1', 'ohs','wallet1')

4.3.10 exportKeyStore

キーストアをファイルにエクスポートするオンライン・コマンドを示します。

4.3.10.1 説明

このコマンドは、指定したディレクトリ内のファイルに指定したOracle仮想ディレクトリ・インスタンスに対して設定したキーストアをエクスポートします。エクスポートしたファイル名は、キーストア名と同じです。

4.3.10.2 構文

exportKeyStore(instName, compName, compType, keystoreName, password, path)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	キーストア・ファイルの名前を指定します。
password	キーストアのパスワードを指定します。
path	キーストアがエクスポートされているディレクトリの絶対パスを指定します。

4.3.10.3 例

次のコマンドは、/tmpの下にあるファイルkeys.jksにOracle仮想ディレクトリ・インスタンスovd1のキーストアkeys.jksをエクスポートします。

wls:/mydomain/serverConfig> exportKeyStore('inst1', 'ovd1', 'ovd', 'keys.jks', 'password', '/tmp')

4.3.11 exportKeyStoreObject

キーストアからファイルにオブジェクトをエクスポートするオンライン・コマンドを示します。

4.3.11.1 説明

次のコマンドは、Javaキーストア(JKS)にある証明書署名要求、証明書/証明書チェーンまたは信頼された証明書を指定したOracle仮想ディレクトリ・インスタンスのファイルにエクスポートします。オブジェクトのエクスポート前に証明書署名要求が作成されます。別名は、エクスポートするオブジェクトを指定します。

4.3.11.2 構文

exportKeyStoreObject(instName, compName, compType, keystoreName, password, type, path, alias)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	キーストア・ファイルの名前を指定します。
password	キーストアのパスワードを指定します。
type	エクスポートするキーストア・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」、「TrustedCertificate」および「TrustedChain」です。
path	オブジェクトをbase64.txtという名前のファイルとしてエクスポートしたディレクトリの絶対パスを指定します。
alias	エクスポートするキーストア・オブジェクトの別名を指定します。

4.3.11.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内の別名mykeyによって指定した鍵ペアからの証明書署名用要求を生成し、エクスポートします。証明書署名用要求は、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'CertificateRequest', '/tmp','mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内の別名mykeyによって指定した証明書または証明書チェーンをエクスポートします。証明書または証明書チェーンは、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'Certificate', '/tmp','mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1ないのOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内の別名mykeyによって指定した信頼された証明書をエクスポートします。信頼された証明書は、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'TrustedCertificate', '/tmp','mykey')

4.3.12 exportWallet

Oracleウォレットをエクスポートするオンライン・コマンドを示します。

4.3.12.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対して設定したOracleウォレットを提供したディレクトリの中にあるファイルにエクスポートします。エクスポートされたファイルは、自動ログインのウォレットの場合、ファイル「cwallet.sso」のみが作成されます。パスワードで保護されているウォレットの場合、ewallet.p12およびcwallet.ssoという2つのファイルが作成されます。

4.3.12.2 構文

exportWallet(instName, compName, compType, walletName,password, path)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「oid」、「ohs」および「webcache」です。
walletName	ウォレット・ファイルの名前を指定します。
password	ウォレットのパスワードを指定します。
path	オブジェクトがエクスポートされているディレクトリの絶対パスを指定します。

4.3.12.3 例

次のコマンドは、Oracleインターネット・ディレクトリ・インスタンスoid1の自動ログイン・ウォレットwallet1を/tmpの中にあるファイルcwallet.ssoにエクスポートします。

wls:/mydomain/serverConfig> exportWallet('inst1', 'oid1', 'oid', 'wallet1','','/tmp')

次のコマンドは、Oracleインターネット・ディレクトリ・インスタンスoid1のパスワード保護したウォレットwallet2を/tmpの中にある2つのファイルewallet.p12およびcwallet.ssoにエクスポートします。

wls:/mydomain/serverConfig> exportWallet('inst1', 'oid1', 'oid', 'wallet2', 'password', '/tmp')

4.3.13 exportWalletObject

証明書またはその他のウォレット・オブジェクトをファイルにエクスポートするオンライン・コマンドを示します。

4.3.13.1 説明

このコマンドは、Oracleウォレットにある証明書署名要求、証明書、証明書チェーンまたは信頼された証明書を指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)のファイルにエクスポートします。DNを使用してエクスポートするオブジェクトを指定します。

4.3.13.2 構文

exportWalletObject(instName, compName, compType, walletName, password, type, path, DN)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。
walletName	ウォレット・ファイルの名前を指定します。
password	ウォレットのパスワードを指定します。
type	エクスポートするウォレット・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」、「TrustedCertificate」または「TrustedChain」です。
path	オブジェクト をbase64.txtという名前のファイルとしてエクスポートしたディレクトリの絶対パスを指定します。
DN	エクスポートするウォレット・オブジェクトの識別された名前を指定します。

4.3.13.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.acme.comを指定した証明書署名要求をエクスポートします。証明書署名用要求は、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportWalletObject('inst1', 'oid1', 
'oid','wallet1', 'password', 'CertificateRequest', '/tmp','cn=www.acme.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.acme.comを指定した証明書をエクスポートします。証明書または証明書チェーンは、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportWalletObject('inst1', 'oid1', 
'oid','wallet1', 'password', 'Certificate', '/tmp','cn=www.acme.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.acme.comを指定した信頼された証明書をエクスポートします。信頼された証明書は、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportWalletObject('inst1', 'oid1', 
'oid','wallet1', 'password', 'TrustedCertificate', '/tmp','cn=www.acme.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.acme.comを指定した証明書チェーンをエクスポートします。証明書または証明書チェーンは、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportWalletObject('inst1', 'oid1', 
'oid','wallet1', 'password', 'TrustedChain', '/tmp','cn=www.acme.com')

4.3.14 generateKey

Javaキーストアに鍵ペアを生成するオンライン・コマンドを示します。

4.3.14.1 説明

このコマンドは、Oracle仮想ディレクトリのJavaキーストア(JKS)に鍵ペアを生成します。また、このコマンドは、鍵ペアを自己署名証明書にラップします。RSAアルゴリズムに基づくキーのみ生成されます。

4.3.14.2 構文

generateKey(instName, compName, compType, keystoreName, password, DN, keySize, alias, algorithm)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
DN	鍵ペア・エントリの識別された名前を指定します。
keySize	キーのサイズをビットの単位で指定します。
alias	キーストア内の鍵ペア・エントリの別名を指定します。
algorithm	キーのアルゴリズムを指定します。有効な値は、「RSA」です。

4.3.14.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してDNとしてcn=www.acme.com、キー・サイズとして1024、アルゴリズムとしてRSAおよび別名としてmykeyを指定した鍵ペアをkeys.jksに生成します。

wls:/mydomain/serverConfig> generateKey('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'cn=www.acme.com', '1024', 'mykey', 'RSA')

次のコマンドは、上記と同じですが、キー・アルゴリズムを明示的に指定しません。

wls:/mydomain/serverConfig> generateKey('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'cn=www.acme.com', '1024', 'mykey')

4.3.15 getKeyStoreObject

キーストア・オブジェクトの詳細情報を表示するオンライン・コマンドを示します。

4.3.15.1 説明

このコマンドは、Oracle仮想ディレクトリに対してJavaキーストア(JKS)にある特定の証明書または信頼された証明書を表示します。キーストア・オブジェクトは、listKeyStoreObjectsコマンドによって指定したインデックス番号で指定されます。これには、DN、キーのサイズ、アルゴリズムおよびその他の情報を含む証明書の詳細情報が表示されます。

4.3.15.2 構文

getKeyStoreObject(instName, compName, compType, keystoreName, password, type, index)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	キーストア・ファイルの名前を指定します。
password	キーストアのパスワードを指定します。
type	表示するキーストア・オブジェクトのタイプを指定します。有効な値は、「Certificate」および「TrustedCertificate」です。
index	listKeyStoreObjectsコマンドによって返されたキーストア・オブジェクトのインデックス番号を指定します。

4.3.15.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内のインデックス1で信頼証明書を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'TrustedCertificate', '1')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内のインデックス1で証明書を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'Certificate', '1')

4.3.16 getSSL

設定済SSL属性を表示するオンライン・コマンドを示します。

4.3.16.1 説明

このコマンドは、指定したコンポーネント・リスナーの設定済のSSL属性を表示します。Oracleインターネット・ディレクトリの場合に常にリスナー名としてsslport1を使用します。

4.3.16.2 構文

getSSL(instName, compName, compType, listener)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」、「oid」、「ohs」および「webcache」です。
リスナー	コンポーネント・リスナーの名前を指定します。

4.3.16.3 例

次のコマンドは、リスナーsslport1に対してアプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対して設定したSSL属性を表示します。

wls:/mydomain/serverConfig> getSSL('inst1', 'oid1', 'oid', 'sslport1')

4.3.17 getWalletObject

Oracleウォレット内の証明書またはその他のオブジェクトに関する情報を表示するオンライン・コマンドを示します。

4.3.17.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対してOracleウォレットにある特定の証明書署名要求、証明書または信頼された証明書を表示します。ウォレット・オブジェクトは、listWalletObjectsコマンドによって指定したインデックス番号で指定されます。証明書または信頼された証明書に対して、DN、キーのサイズ、アルゴリズムおよびその他のデータを含む証明書の詳細情報を表示します。証明書署名要求に対して、サブジェクトDN、キーのサイズおよびアルゴリズムを表示します。

4.3.17.2 構文

getWalletObject(instName, compName, compType, walletName, password, type, index)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。
walletName	ウォレット・ファイルの名前を指定します。
password	ウォレットのパスワードを指定します。
type	エクスポートするウォレット・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」および「TrustedCertificate」です。
index	listWalletObjectsコマンドによって返されたウォレット・オブジェクトのインデックス番号を指定します。

4.3.17.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にあるインデックス0でオブジェクトの証明書署名要求の詳細情報を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'oid1', 'oid','wallet1','password', 'CertificateRequest', '0')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスのoid1に対してwallet1にあるインデックス0でオブジェクトの証明書の詳細情報を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'oid1', 'oid','wallet1','password', 'Certificate', '0')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスのoid1に対してwallet1にあるインデックス0でオブジェクトの信頼性のある証明書の詳細情報を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'oid1', 'oid','wallet1','password', 'TrustedCertificate', '0')

4.3.18 importKeyStore

ファイルからキーストアをインポートするオンライン・コマンドを示します。

4.3.18.1 説明

このコマンドは、管理可能性のためにJavaキーストア(JKS)をファイルから指定したOracle仮想ディレクトリ・インスタンスにインポートします。コンポーネント・インスタンス名はユニークである必要があります。

4.3.18.2 構文

importKeyStore(instName, compName, compType, keystoreName, password, filePath)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	インポートされているキーストアの名前を指定します。このコンポーネントに対してこの名前がユニークである必要があります。
password	キーストアのパスワードを指定します。
filePath	インポートするキーストア・ファイルの絶対パスを指定します。

4.3.18.3 例

次のコマンドは、Oracle仮想ディレクトリ・インスタンスovd1にキーストア/tmp/keys.jksをfile.jksとしてインポートします。その後、キーストアがfile.jksの名前を使用して管理されます。

wls:/mydomain/serverConfig> importKeyStore('inst1', 'ovd1', 'ovd', 'file.jks',
'password', '/tmp/keys.jks')

4.3.19 importKeyStoreObject

オブジェクトをファイルからキーストアにインポートするオンライン・コマンドを示します。

4.3.19.1 説明

このコマンドは、証明書、証明書チェーンまたは信頼された証明書にキーストアにユニークである必要がある指定した別名を割り当てることにより、Oracle仮想ディレクトリのJavaキーストア(JKS)にインポートします。証明書または証明書チェーンがインポートされている場合、別名は、対応する鍵ペアと一致する必要があります。

4.3.19.2 構文

importKeyStoreObject(instName, compName, compType, keystoreName, password, type, filePath, alias)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
type	インポートするキーストア・オブジェクトのタイプを指定します。有効な値は、「Certificate」および「TrustedCertificate」です。
filePath	キーストア・オブジェクトを含むファイルの絶対パスを指定します。
alias	インポートするキーストア・オブジェクトに割り当てる別名を指定します。

4.3.19.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、別名mykeyを使用してファイルcert.txtからの証明書または証明書チェーンをkeys.jksにインポートします。ファイルkeys.jksには、インポートする証明書内の公開鍵と一致する鍵ペアに対して、すでに別名mykeyを含まれている必要があります。

wls:/mydomain/serverConfig> > importKeyStoreObject('inst1', 'ovd1', 
'ovd','keys.jks', 'password', 'Certificate','/tmp/cert.txt', 'mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、別名mykeyを使用してファイルtrust.txtからの信頼された証明書をkeys.jksにインポートします。

wls:/mydomain/serverConfig> importKeyStoreObject('inst1', 'ovd1', 
'ovd','keys.jks', 'password', 'TrustedCertificate','/tmp/trust.txt', 'mykey1')

4.3.20 importWallet

ファイルからOracleウォレットをインポートするオンライン・コマンドを示します。

4.3.20.1 説明

このコマンドは、管理可能性のためにOracleウォレットをファイルから指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)にインポートします。インポートされているウォレットが、自動ログイン・ウォレットの場合、ファイル・パスは、cwallet.ssoを参照する必要があります。ウォレットが、パスワード保護されている場合、ファイル・パスは、ewallet.p12を参照する必要があります。ウォレット名は、コンポーネント・インスタンスに対してユニークである必要があります。

4.3.20.2 構文

importWallet(instName, compName, compType, walletName, password, filePath)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。
walletName	インポートされているウォレットの名前を指定します。ウォレット名は、コンポーネント・インスタンスに対してユニークである必要があります。
password	ウォレットのパスワードを指定します。
filePath	インポートされているウォレット・ファイルの絶対パスを指定します。

4.3.20.3 例

次のコマンドは、自動ログイン・ウォレット・ファイル/tmp/cwallet.ssoをwallet1としてOracleインターネット・ディレクトリ・インスタンスoid1にインポートします。その後、ウォレットがwallet1という名前で管理されます。自動ログイン・ウォレットなので、パスワードを指定しません。

wls:/mydomain/serverConfig> importWallet('inst1', 'oid1', 'oid', 'wallet1', '', '/tmp/cwallet.sso')

次のコマンドは、パスワード保護したウォレット/tmp/ewallet.p12をwallet2としてOracleインターネット・ディレクトリ・インスタンスoid1にインポートします。その後、ウォレットがwallet2という名前で管理されます。ウォレットのパスワードがパラメータとして渡されます。

wls:/mydomain/serverConfig> importWallet('inst1', 'oid1', 'oid', 'wallet2', 'password', '/tmp/ewallet.p12')

4.3.21 importWalletObject

Oracleウォレットに証明書またはその他のオブジェクトをインポートするオンライン・コマンドを示します。

4.3.21.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheコンポーネントまたはOracleインターネット・ディレクトリ)に対して証明書、信頼された証明書または証明書チェーンをOracleウォレットにインポートします。証明書のインポート時、証明書署名要求の生成先ウォレット・ファイルを使用します。

4.3.21.2 構文

importWalletObject(instName, compName, compType, walletName, password, type, filePath)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。
walletName	ウォレット・ファイルの名前を指定します。
password	ウォレットのパスワードを指定します。
type	インポートするウォレット・オブジェクトのタイプを指定します。有効な値は、「Certificate」、「TrustedCertificate」および「TrustedChain」です。
filePath	ウォレット・オブジェクトを含むファイルの絶対パスを指定します。

4.3.21.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対して証明書チェーンをPKCS#7フォーマットを使用してファイルchain.txtからwallet1にインポートします。

wls:/mydomain/serverConfig> importWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'TrustedChain','/tmp/chain.txt')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対して証明書ファイルcert.txtからwallet1にインポートします。

wls:/mydomain/serverConfig> importWalletObject('inst1', 'oid1', 'oid','wallet1', 
'password', 'Certificate','/tmp/cert.txt')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対して信頼された証明書ファイルtrust.txtからwallet1にインポートします。

wls:/mydomain/serverConfig> importWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'TrustedCertificate','/tmp/trust.txt')

4.3.22 listKeyStoreObjects

キーストアの内容を表示するオンライン・コマンドを示します。

4.3.22.1 説明

このコマンドは、Oracle仮想ディレクトリのJavaキーストア(JKS)にある証明書または信頼された証明書を表示します。

4.3.22.2 構文

listKeyStoreObjects(instName, compName, compType, keystoreName, password, type)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	キーストア・ファイルの名前を指定します。
password	キーストアのパスワードを指定します。
type	表示するキーストア・オブジェクトのタイプを指定します。有効な値は、「Certificate」および「TrustedCertificate」です。

4.3.22.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、keys.jksにあるすべての信頼された証明書を表示します。

wls:/mydomain/serverConfig> listKeyStoreObjects('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'TrustedCertificate')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、keys.jksにあるすべての証明書を表示します。

wls:/mydomain/serverConfig> listKeyStoreObjects('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'Certificate')

4.3.23 listKeyStores

コンポーネントのすべてのキーストアを表示するオンライン・コマンドを示します。

4.3.23.1 説明

このコマンドは、指定したOracle仮想ディレクトリ・インスタンスに対して設定したすべてのJavaキーストア(JKS)を表示します。

4.3.23.2 構文

listKeyStores(instName, compName, compType)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。

4.3.23.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1のすべてのキーストアを表示します。

wls:/mydomain/serverConfig> listKeyStores('inst1', 'ovd1', 'ovd')

4.3.24 listWalletObjects

Oracleウォレットにあるすべてのオブジェクトを表示するオンライン・コマンドを示します。

4.3.24.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対してOracleウォレットにあるすべての証明書署名要求、証明書または信頼された証明書を表示します。

4.3.24.2 構文

listWalletObjects(instName, compName, compType, walletName, password, type)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。
walletName	ウォレット・ファイルの名前を指定します。
password	ウォレットのパスワードを指定します。
type	表示するウォレット・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」および「TrustedCertificate」です。

4.3.24.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべての証明書署名要求をwallet1に表示します。

wls:/mydomain/serverConfig> > listWalletObjects('inst1', 'oid1', 'oid','wallet1','password', 'CertificateRequest')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべての証明書をwallet1に表示します。

wls:/mydomain/serverConfig> listWalletObjects('inst1', 'oid1', 'oid','wallet1','password', 'Certificate')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべての信頼された証明書をwallet1に表示します。

wls:/mydomain/serverConfig> listWalletObjects('inst1', 'oid1', 'oid','wallet1','password', 'TrustedCertificate')

4.3.25 listWallets

コンポーネント・インスタンスに対して設定したすべてのウォレットを表示するオンライン・コマンドを示します。

4.3.25.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対して指定したすべてのウォレットを表示し、自動ログイン・ウォレットを識別します。

4.3.25.2 構文

listWallets(instName, compName, compType)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

4.3.25.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべてのウォレットをに表示します。

wls:/mydomain/serverConfig> listWallets('inst1', 'oid1', 'oid')

4.3.26 removeKeyStoreObject

キーストアからオブジェクトを削除するオンライン・コマンドを示します。

4.3.26.1 説明

このコマンドは、Oracle仮想ディレクトリのJavaキーストア(JKS)から証明書要求、証明書、信頼された証明書またはすべての信頼された証明書を削除します。別名を使用して特定のオブジェクトを削除します。すべての信頼された証明書が削除されている場合は、別名を使用する必要はありません。

4.3.26.2 構文

removeKeyStoreObject(instName, compName, compType, keystoreName, password, type, alias)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ovd」です。
keystoreName	キーストア・ファイルの名前を指定します。
password	キーストアのパスワードを指定します。
type	削除するキーストア・オブジェクトのタイプを指定します。有効な値は、「Certificate」、「TrustedCertificate」または「TrustedAll」です。
alias	削除するキーストア・オブジェクトの別名を指定します。

4.3.26.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、keys.jks内の別名mykeyによって指定された証明書または証明書チェーンを削除します。

wls:/mydomain/serverConfig> removeKeyStoreObject('inst1', 'ovd1', 
'ovd','keys.jks', 'password', 'Certificate','mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内の別名mykeyによって指定した信頼された証明書を削除します。

wls:/mydomain/serverConfig> removeKeyStoreObject('inst1', 'ovd1', 
'ovd','keys.jks', 'password', 'TrustedCertificate','mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、keys.jksにあるすべての信頼された証明書を削除します。別名を使用する必要はないので、そのパラメータになしという値が渡されます。

wls:/mydomain/serverConfig> removeKeyStoreObject('inst1', 'ovd1', 
'ovd','keys.jks', 'password', 'TrustedAll',None)

4.3.27 removeWalletObject

Oracleウォレットから証明書またはその他のオブジェクトを削除するオンライン・コマンドを示します。

4.3.27.1 説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対してOracleウォレットから証明書署名要求、証明書またはすべての信頼された証明書を削除します。DNを使用して削除するオブジェクトを指定します。

4.3.27.2 構文

removeWalletObject(instName, compName, compType, walletName, password, type, DN)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。
walletName	ウォレット・ファイルの名前を指定します。
password	ウォレットのパスワードを指定します。
type	削除するキーストア・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」、「TrustedCertificate」または「TrustedAll」です。
DN	削除するウォレット・オブジェクトの識別された名前を指定します。

4.3.27.3 例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべての信頼された証明書をwallet1から削除します。DNを指定する必要はないので、DNパラメータにnull (Noneで指定される)を渡します。

wls:/mydomain/serverConfig> removeWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'TrustedAll',None)

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のDNとしてcn=www.acme.comを指定した証明書署名要求をwallet1から削除します。

wls:/mydomain/serverConfig> removeWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'CertificateRequest','cn=www.acme.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のDNとしてcn=www.acme.comを指定した証明書をwallet1から削除します。

wls:/mydomain/serverConfig> removeWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'Certificate','cn=www.acme.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のDNとしてcn=www.acme.comを指定した信頼された証明書をwallet1から削除します。

wls:/mydomain/serverConfig> removeWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'TrustedCertificate','cn=www.acme.com')

4.4 Oracle Identity Federationのコマンド

表4-4に指定されているWLSTコマンドを使用して、Oracle ID連合の設定を表示し管理します。

表4-4 Oracle ID連合のWLSTコマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
addConfigListEntryInMap	マップに設定リスト・エントリを追加します。	オンライン
addConfigMapEntryInMap	マップに設定マップ・エントリを追加します。	オンライン
addConfigPropertyListEntry	設定プロパティ・リスト・エントリを追加します。	オンライン
addConfigPropertyMapEntry	マップに設定プロパティ・マップ・エントリを追加します。	オンライン
addCustomAuthnEngine	カスタム認証エンジンを追加します。	オンライン
addCustomSPEngine	カスタムSPエンジンを追加します。	オンライン
addFederationListEntryInMap	マップに連合リスト・エントリを追加します。	オンライン
addFederationMapEntryInMap	マップに連合 マップ・エントリを追加します。	オンライン
addFederationPropertyListEntry	連合プロパティ・リスト・エントリを追加します。	オンライン
addFederationPropertyMapEntry	連合プロパティ・マップ・エントリを追加します。	オンライン
deleteCustomAuthnEngine	カスタム認証エンジンを削除します。	オンライン
deleteCustomSPEngine	カスタムSPエンジンを削除します。	オンライン
deleteProviderFederation	連合からプロバイダを削除します。	オンライン
deleteUserFederation	連合からユーザーを削除します。	オンライン
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管理者ガイド』を参照してください。

4.4.1 addConfigListEntryInMap

マップにプロパティ値を追加するオンライン・コマンドを示します。

4.4.1.1 説明

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

4.4.1.2 構文

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

引数	定義
configname	更新する設定の名前を指定します(idpsaml20、serverconfig、spsaml20など)。
mapname	config.xmlに変更する必要があるマップへのプロパティの名前を指定します。
listname	リストの名前を指定します。
value	プロパティの値を指定します。
type	プロパティのタイプ(BOOLEANまたはSTRINGまたはLONG)を指定します。

4.4.1.3 例

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

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

4.4.2 addConfigMapEntryInMap

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

4.4.2.1 説明

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

4.4.2.2 構文

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

引数	定義
configName	更新する設定の名前を指定します(idpsaml20、serverconfig、spsaml20など)。
mapname	config.xmlに変更する必要があるプロパティ・マップの名前を指定します。
nestedMapName	変更するネストされたプロパティ・マップの名前を示します。
propName	リストの名前を指定します。
value	プロパティの値を指定します。
type	プロパティのタイプ(BOOLEANまたはSTRINGまたはLONG)を指定します。

4.4.2.3 例

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

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

4.4.3 addConfigPropertyListEntry

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

4.4.3.1 説明

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

4.4.3.2 構文

addConfigPropertyListEntry(configName, listName, value, type)

引数	定義
configName	更新する設定の名前を指定します(idpsaml20、serverconfig、spsaml20など)。
listName	config.xmlに追加する必要があるプロパティ・リストの名前を指定します。
value	新しいプロパティ・リスト値を指定します。入力した値がリストに追加されます。
type	プロパティのタイプ(BOOLEANまたはSTRINGまたはLONG)を指定します。

4.4.3.3 例

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

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

4.4.4 addConfigPropertyMapEntry

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

4.4.4.1 説明

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

4.4.4.2 構文

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

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

4.4.4.3 例

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

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

4.4.5 addCustomAuthnEngine

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

4.4.5.1 説明

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

4.4.5.2 構文

addCustomAuthnEngine(name, [enabled], [webContext], [authnRelativePath],  [logoutRelativePath], [logoutEnabled])

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

4.4.5.3 例

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

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

4.4.6 addCustomSPEngine

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

4.4.6.1 説明

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

4.4.6.2 構文

addCustomSPEngine(name, [enabled, [authnMech], [webContext], [authnRelativePath], [logoutRelativePath], [logoutEnabled])

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

4.4.6.3 例

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

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

4.4.7 addFederationListEntryInMap

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

4.4.7.1 説明

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

4.4.7.2 構文

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

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

4.4.7.3 例

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

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

4.4.8 addFederationMapEntryInMap

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

4.4.8.1 説明

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

4.4.8.2 構文

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

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

4.4.8.3 例

次のコマンドは、ネストされたマップ内のmyvarAプロパティにString型の値を追加します。

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

4.4.9 addFederationPropertyListEntry

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

4.4.9.1 説明

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

4.4.9.2 構文

addFederationPropertyListEntry(providerID, listName, value, type)

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

4.4.9.3 例

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

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

4.4.10 addFederationPropertyMapEntry

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

4.4.10.1 説明

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

4.4.10.2 構文

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

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

4.4.10.3 例

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

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

4.4.11 deleteCustomAuthnEngine

設定からカスタム認証統合エンジンを削除するオンライン・コマンドを示します。

4.4.11.1 説明

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

4.4.11.2 構文

deleteCustomAuthnEngine(engineID)

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

4.4.11.3 例

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

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

4.4.12 deleteCustomSPEngine

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

4.4.12.1 説明

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

4.4.12.2 構文

ddeleteCustomSPEngine(engineID)

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

4.4.12.3 例

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

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

4.4.13 deleteProviderFederation

指定したプロバイダの連合を削除するオンライン・コマンドを示します。

4.4.13.1 説明

このコマンドは、指定したプロバイダIDの連合を削除します。

4.4.13.2 構文

deleteProviderFederation(providerID)

引数	定義
providerID	連合を削除する必要があるピア・プロバイダのProviderIDを指定します。

4.4.13.3 例

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

wls:/mydomain/serverConfig> deleteProviderFederation(providerA)

4.4.14 deleteUserFederation

指定したユーザーの連合を削除するオンライン・コマンドを示します。

4.4.14.1 説明

このコマンドは、指定したユーザーのリストの連合を削除します。

4.4.14.2 構文

deleteUserFederation([user1, ...])

引数	定義
user1	連合を削除するユーザーのカンマ区切りのリストを指定します。ユーザーが最低1つ指定する必要があります。

4.4.14.3 例

次のコマンドは、3つのユーザーの連合を削除します。

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

4.4.15 changeMessageStore

メモリーおよびRDBMSの間のメッセージ・ストアを変更するオンライン・コマンドを示します。

4.4.15.1 説明

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

4.4.15.2 構文

changeMessageStore(type, [jndiname])

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

4.4.15.3 例

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

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

4.4.16 changePeerProviderDescription

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

4.4.16.1 説明

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

4.4.16.2 構文

changePeerProviderDescription(providerID, description)

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

4.4.16.3 例

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

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

4.4.17 changeSessionStore

メモリーおよびRDBMSの間のセッション・ストアを変更するオンライン・コマンドを示します。

4.4.17.1 説明

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

4.4.17.2 構文

changeSessionStore(type, [jndiname])

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

4.4.17.3 例

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

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

4.4.18 createConfigPropertyList

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

4.4.18.1 説明

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

4.4.18.2 構文

createConfigPropertyList(configName, listName)

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

4.4.18.3 例

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

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

4.4.19 createConfigPropertyListInMap

プロパティ・マップにネストされているプロパティ・リストを作成するオンライン・コマンドを示します。

4.4.19.1 説明

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

4.4.19.2 構文

createConfigPropertyListInMap(configName, mapName, listName)

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

4.4.19.3 例

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

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

4.4.20 createConfigPropertyMap

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

4.4.20.1 説明

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

4.4.20.2 構文

createConfigPropertyMap(configName, mapName)

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

4.4.20.3 例

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

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

4.4.21 createConfigPropertyMapInMap

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

4.4.21.1 説明

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

4.4.21.2 構文

createConfigPropertyMapInMap(configName, mapName, nestedMapName)

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

4.4.21.3 例

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

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

4.4.22 createFederationPropertyList

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

4.4.22.1 説明

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

4.4.22.2 構文

createFederationPropertyList(providerID, listName)

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

4.4.22.3 例

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

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

4.4.23 createFederationPropertyListInMap

プロパティ・マップにネストされているプロパティ・リストを作成するオンライン・コマンドを示します。

4.4.23.1 説明

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

4.4.23.2 構文

createFederationPropertyListInMap(providerID, mapName, listName)

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

4.4.23.3 例

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

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

4.4.24 createFederationPropertyMap

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

4.4.24.1 説明

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

4.4.24.2 構文

createFederationPropertyMap(providerID, mapName)

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

4.4.24.3 例

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

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

4.4.25 createFederationPropertyMapInMap

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

4.4.25.1 説明

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

4.4.25.2 構文

createFederationPropertyMapInMap(providerID, mapName, nestedMapName)

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

4.4.25.3 例

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

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

4.4.26 createPeerProviderEntry

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

4.4.26.1 説明

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

4.4.26.2 構文

createPeerProviderEntry(providerID, description, providerType, version)

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

4.4.26.3 例

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

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

4.4.27 getConfigListValueInMap

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

4.4.27.1 説明

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

4.4.27.2 構文

getConfigListValueInMap(configName, mapName, listName)

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

4.4.27.3 例

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

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

4.4.28 getConfigMapEntryInMap

マップにネストされたマップ・プロパティ・エントリを返すオンライン・コマンドを示します。

4.4.28.1 説明

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

4.4.28.2 構文

getConfigMapEntryInMap(configName, mapname, nestedMapName, propName)

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

4.4.28.3 例

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

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

4.4.29 getConfigProperty

プロパティの値を返すオンライン・コマンドを示します。

4.4.29.1 説明

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

4.4.29.2 構文

getConfigProperty(configName, propName)

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

4.4.29.3 例

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

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

4.4.30 getConfigPropertyList

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

4.4.30.1 説明

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

4.4.30.2 構文

getConfigPropertyList(configName, listName)

引数	定義
configName	設定の名前を指定します。
listName	config.xmlから取得する必要があるプロパティ・リストの名前を指定します。

4.4.30.3 例

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

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

4.4.31 getConfigPropertyMapEntry

マップからのプロパティ値を返すオンライン・コマンドを示します。

4.4.31.1 説明

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

4.4.31.2 構文

getConfigPropertyMapEntry(configName, mapName, propName)

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

4.4.31.3 例

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

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

4.4.32 getFederationListValueInMap

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

4.4.32.1 説明

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

4.4.32.2 構文

getFederationListValueInMap(providerID, mapName, listName)

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

4.4.32.3 例

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

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

4.4.33 getFederationMapEntryInMap

マップにネストされたマップ・プロパティ・エントリを返すオンライン・コマンドを示します。

4.4.33.1 説明

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

4.4.33.2 構文

getFederationMapEntryInMap(providerID, mapname, nestedMapName, propName)

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

4.4.33.3 例

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

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

4.4.34 getFederationProperty

プロパティの値を返すオンライン・コマンドを示します。

4.4.34.1 説明

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

4.4.34.2 構文

getFederationProperty(providerID, propName)

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

4.4.34.3 例

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

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

4.4.35 getFederationPropertyList

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

4.4.35.1 説明

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

4.4.35.2 構文

getFederationPropertyList(providerID, listName)

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

4.4.35.3 例

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

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

4.4.36 extractproviderprops

プロバイダのプロパティをエクスポートするWLSTスクリプトです。

4.4.36.1 説明

指定されたプロバイダのすべての構成プロパティを抽出し、テキスト・ファイルにエクスポートするWLSTスクリプトです。このファイルは、後で別のプロバイダで同じプロパティを設定する際に使用できます。このコマンドは、WLSTコマンド・シェルからではなく、UNIXまたはWindowsのコマンド・シェル・プロンプトから実行してください。このスクリプトは、ORACLE_HOME/fed/scriptsに格納されています。

4.4.36.2 構文

extractproviderprops.py providerID filename

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

スクリプトを実行すると、WebLogic管理者資格証明および接続URLを要求されます。後者には、管理サーバー・ポートではなく、管理対象サーバー・ポートを指定してください。

ファイル形式

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

TYPE:NAME:PROPNAME:PROPVALUE:PROPTYPE

例:

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

4.4.37 setproviderprops

テキスト・ファイルからの値を使用してプロバイダのプロパティを設定するWLSTスクリプトです。

4.4.37.1 説明

テキスト・ファイルからの値を使用してプロバイダのプロパティを設定するWLSTスクリプトです。このコマンドは、WLSTコマンド・シェルからではなく、UNIXまたはWindowsのコマンド・シェル・プロンプトから実行してください。このスクリプトは、ORACLE_HOME/fed/scriptsに格納されています。

テキスト・ファイルは、extractproviderpropsコマンドによって生成されます。

4.4.37.2 構文

setproviderprops.py providerID filename

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

スクリプトを実行すると、WebLogic管理者資格証明および接続URLを要求されます。後者には、管理サーバー・ポートではなく、管理対象サーバー・ポートを指定してください。

4.4.38 getFederationPropertyMapEntry

マップからのプロパティ値を返すオンライン・コマンドを示します。

4.4.38.1 説明

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

4.4.38.2 構文

getFederationPropertyMapEntry(providerID, mapName, propName)

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

4.4.38.3 例

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

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

4.4.39 listCustomAuthnEngines

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

4.4.39.1 説明

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

4.4.39.2 構文

listCustomAuthnEngines()

4.4.39.3 例

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

wls:/mydomain/serverConfig> listCustomAuthnEngines()

4.4.40 listCustomSPEngines

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

4.4.40.1 説明

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

4.4.40.2 構文

listCustomSPEngines()

4.4.40.3 例

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

wls:/mydomain/serverConfig> listCustomSPEngines()

4.4.41 loadMetadata

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

4.4.41.1 説明

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

4.4.41.2 構文

loadMetadata(metadatafile,description)

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

4.4.41.3 例

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

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

4.4.42 oifStatus

WLSTが接続されている管理対象サーバーのOracle Identity Federationアプリケーションの現在のステータスをレポートするオンライン・コマンド。

4.4.42.1 説明

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

4.4.42.2 構文

loifStatus('serverurl', 'configfile', 'keyfile')

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

4.4.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')

4.4.43 removeConfigListInMap

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

4.4.43.1 説明

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

4.4.43.2 構文

removeConfigListInMap(configName, mapName, listName)

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

4.4.43.3 例

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

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

4.4.44 removeConfigMapEntryInMap

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

4.4.44.1 説明

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

4.4.44.2 構文

removeConfigMapEntryInMap(configName, mapname, nestedMapName, propName)

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

4.4.44.3 例

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

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

4.4.45 removeConfigMapInMap

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

4.4.45.1 説明

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

4.4.45.2 構文

removeConfigMapEntryInMap(configName, mapName, nestedMapName, propName)

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

4.4.45.3 例

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

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

4.4.46 removeConfigProperty

設定プロパティを削除するオンライン・コマンドを示します。

4.4.46.1 説明

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

4.4.46.2 構文

removeConfigProperty(configName, propName)

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

4.4.46.3 例

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

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

4.4.47 removeConfigPropertyList

設定プロパティ・リストを削除するオンライン・コマンドを示します。

4.4.47.1 説明

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

4.4.47.2 構文

removeConfigPropertyList(configName, listName)

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

4.4.47.3 例

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

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

4.4.48 removeConfigPropertyMap

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

4.4.48.1 説明

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

4.4.48.2 構文

removeConfigPropertyMap(configName, mapName)

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

4.4.48.3 例

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

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

4.4.49 removeConfigPropertyMapEntry

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

4.4.49.1 説明

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

4.4.49.2 構文

removeConfigPropertyMapEntry(configName, mapName, propName)

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

4.4.49.3 例

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

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

4.4.50 removeFederationListInMap

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

4.4.50.1 説明

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

4.4.50.2 構文

removeFederationListInMap(providerID, mapName, listName)

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

4.4.50.3 例

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

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

4.4.51 removeFederationMapInMap

マップ内のネストされたマップを削除するオンライン・コマンドを示します。

4.4.51.1 説明

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

4.4.51.2 構文

removeFederationMapInMap(providerID, mapname, nestedMapName)

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

4.4.51.3 例

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

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

4.4.52 removeFederationMapEntryInMap

マップからネストされたマップ・プロパティ・エントリを削除するオンライン・コマンドを示します。

4.4.52.1 説明

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

4.4.52.2 構文

removeFederationMapEntryInMap(providerID, mapname, nestedMapName, propName)

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

4.4.52.3 例

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

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

4.4.53 removeFederationProperty

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

4.4.53.1 説明

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

4.4.53.2 構文

removeFederationProperty(providerID, propName)

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

4.4.53.3 例

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

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

4.4.54 removeFederationPropertyList

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

4.4.54.1 説明

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

4.4.54.2 構文

removeFederationPropertyList(providerID, listName)

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

4.4.54.3 例

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

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

4.4.55 removeFederationPropertyMap

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

4.4.55.1 説明

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

4.4.55.2 構文

removeFederationPropertyMap(providerID, mapName)

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

4.4.55.3 例

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

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

4.4.56 removeFederationPropertyMapEntry

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

4.4.56.1 説明

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

4.4.56.2 構文

removeFederationPropertyMapEntry(providerID, mapName, propName)

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

4.4.56.3 例

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

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

4.4.57 removePeerProviderEntry

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

4.4.57.1 説明

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

4.4.57.2 構文

removePeerProviderEntry(providerID)

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

4.4.57.3 例

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

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

4.4.58 setConfigProperty

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

4.4.58.1 説明

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

4.4.58.2 構文

setConfigProperty(configname, propName, value, type)

引数	定義
configName	更新する設定の名前を指定します(idpsaml20、serverconfig、spsaml20など)。
propName	config.xmlに追加/更新する必要があるプロパティの名前を指定します。
value	プロパティの値を指定します。
type	プロパティのタイプ(BOOLEANまたはSTRINGまたはLONG)を指定します。

4.4.58.3 例

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

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

4.4.59 setCustomAuthnEngine

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

4.4.59.1 説明

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

4.4.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に設定します。

4.4.59.3 例

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

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

4.4.60 setCustomSPEngine

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

4.4.60.1 説明

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

4.4.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に設定します。

4.4.60.3 例

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

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

4.4.61 setFederationProperty

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

4.4.61.1 説明

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

4.4.61.2 構文

setFederationProperty(providerID, propName, value, type)

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

4.4.61.3 例

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

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

4.5 ディレクトリ統合プラットフォーム・コマンド

Directory Integration Platform (DIP)ツールの一部は、WLSTを内部的に使用しているので、WLSTコマンド・プロンプトから実行可能なまたはスクリプト内から使用するカスタムWLSTコマンドは存在しない。DIPツールの詳細は、Oracle Fusion Middleware Oracle Identity Managementリファレンスのディレクトリ統合プラットフォーム・ツールに関する項を参照してください。

4.6 セキュリティ・コマンド

表4-5に示されているWLSTセキュリティ・コマンドを使用して、ドメイン・ポリシーまたは資格証明ストアの操作、ソース・リポジトリからターゲット・リポジトリへのポリシーおよび資格証明の移行、および(資格証明の)暗号化鍵のエクスポートとインポートを行います。

表4-5 WLSTセキュリティ・コマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
addBootStrapCredential	資格証明をブート・ストラップ資格証明ストアに追加します。	オフライン
addResourceToEntitlement	資格にリソースを追加します。	オンライン
createAppRole	新しいアプリケーション・ロールを作成します。	オンライン
createCred	新しい資格証明を作成します。	オンライン
createEntitlement	資格を作成します。	オンライン
createResource	リソースを作成します。	オンライン
createResourceType	新しいリソース・タイプを作成します。	オンライン
deleteAppPolicies	アプリケーション内のすべてのポリシーを削除します。	オンライン
deleteAppRole	アプリケーション・ロールを削除します。	オンライン
deleteCred	資格証明を削除します。	オンライン
deleteEntitlement	資格を削除します。	オンライン
deleteResource	リソースを削除します。	オンライン
deleteResourceType	既存のリソース・タイプを削除します。	オンライン
exportEncryptionKey	ドメイン暗号化鍵をファイルewallet.p12にエクスポートします。	オフライン
getEntitlement	資格を一覧表示します。	オンライン
getResourceType	既存のリソース・タイプをフェッチします。	オンライン
grantAppRole	ロールにプリンシパルを追加します。	オンライン
grantEntitlement	資格を作成します。	オンライン
grantPermission	新しいパーミッションを作成します。	オンライン
importEncryptionKey	ファイルewallet.p12内の暗号化鍵をドメインにインポートします。	オフライン
listAppRoles	アプリケーション内のすべてのロールを表示します。	オンライン
listAppRolesMembers	アプリケーション・ロール内のすべてのメンバーを表示します。	オンライン
listAppStripes	ポリシー・ストア内のアプリケーション・ストライプを一覧表示します。	オンライン
listCodeSourcePermissions	グローバル・ポリシーのソース・コードに割り当てられている権限を一覧表示します。	オンライン
listEntitlements	アプリケーション・ストライプ内の資格を一覧表示します。	オンライン
listPermissions	プリンシパルに付与されたすべてのパーミッションを表示します。	オンライン
listResources	アプリケーション・ストライプ内のリソースを一覧表示します。	オンライン
listResourceActions	リソースのアクションを一覧表示します。	オンライン
listResourceTypes	アプリケーション・ストライプ内のリソース・タイプを一覧表示します。	オンライン
listSecurityStoreInfo	OPSSセキュリティ・ストアのタイプと場所、およびアクセスを許可されているユーザーを一覧表示します。	オフライン
migrateSecurityStore	ポリシーまたは資格証明をソース・リポジトリから対象リポジトリに移動します。	オフライン
modifyBootStrapCredential	ブート・ストラップ資格証明ストアを更新します	オフライン
reassociateSecurityStore	ポリシーおよび資格証明をLDAPリポジトリに再び関連付けます	オンライン
restoreEncryptionKey	ドメイン暗号化鍵を、直近のインポートの前の状態にリストアします。	オフライン
revokeEntitlement	資格を削除します。	オンライン
revokeAppRole	ロールからプリンシパルを削除します。	オンライン
revokePermission	パーミッションを削除します。	オンライン
revokeResourceFromEntitlement	資格からリソースを削除します	オンライン
rollOverEncryptionKey	新規の資格証明ストア暗号化鍵を作成します。	オフライン
updateCred	資格証明の属性の値を変更します。	オンライン
updateTrustServiceConfig	トラスト・ストアの構成を更新します。	オンライン
upgradeSecurityStore	セキュリティ・データをリリース10.1.xに使用されたデータからリリース11に使用されたデータにアップグレードします。	オフライン

4.6.1 createAppRole

新しいアプリケーション・ロールを作成するオンライン・コマンドを示します。

4.6.1.1 説明

指定したアプリケーションおよびロール名のアプリケーション・ロールをドメイン・ポリシー・ストアに作成します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.1.2 構文

createAppRole(appStripe, appRoleName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

4.6.1.3 例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleの新しいアプリケーション・ロールを作成します。

wls:/mydomain/serverConfig> createAppRole(appStripe="myApp", appRoleName="myRole")

4.6.2 deleteAppRole

アプリケーション・ロールを削除するオンライン・コマンドを示します。

4.6.2.1 説明

指定したアプリケーションおよびロール名のアプリケーション・ロールをドメイン・ポリシー・ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.2.2 構文

createAppRole(appStripe, appRoleName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

4.6.2.3 例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleのロールを削除します。

wls:/mydomain/serverConfig> createAppRole(appStripe="myApp", appRoleName="myRole")

4.6.3 grantAppRole

ロールにプリンシパルを追加するオンライン・コマンドを示します。

4.6.3.1 説明

指定したアプリケーション・ストライプおよび名前のロールにプリンシパル(クラスまたは名前)を追加します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.3.2 構文

grantAppRole(appStripe, appRoleName,principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。
principalClass	クラスの完全修飾名を指定します。
principalName	プリンシパルの名前を指定します。

4.6.3.3 例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleのロールにプリンシパルを追加します。

wls:/mydomain/serverConfig> grantAppRole(appStripe="myApp",  
appRoleName="myRole",principalClass="com.example.xyzPrincipal",
principalName="myPrincipal")

4.6.4 revokeAppRole

ロールからプリンシパルを削除するオンライン・コマンドを示します。

4.6.4.1 説明

指定したアプリケーション・ストライプおよび名前のロールからプリンシパル(クラスまたは名前)を削除します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.4.2 構文

revokeAppRole(appStripe, appRoleName, principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。
principalClass	クラスの完全修飾名を指定します。
principalName	プリンシパルの名前を指定します。

4.6.4.3 例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleのロールからプリンシパルを削除します。

wls:/mydomain/serverConfig> revokeAppRole(appStripe="myApp", 
appRoleName="myRole",principalClass="com.example.xyzPrincipal", 
principalName="myPrincipal")

4.6.5 listAppRoles

アプリケーション内のすべてのロールを表示するオンライン・コマンドを示します。

4.6.5.1 説明

指定したアプリケーション・ストライプ内のすべてのロールを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.5.2 構文

listAppRoles(appStripe)

引数	定義
appStripe	アプリケーション・ストライプを指定します。

4.6.5.3 例

次の呼出しは、アプリケーション・ストライプmyAppのすべてのロールを返します。

wls:/mydomain/serverConfig> listAppRoles(appStripe="myApp")

4.6.6 listAppRolesMembers

ロール内のすべてのメンバーを表示するオンライン・コマンドを示します。

4.6.6.1 説明

指定したアプリケーション・ストライプおよびロール名のロール内のすべてのメンバーを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.6.2 構文

listAppRoleMembers(appStripe, appRoleName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

4.6.6.3 例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleのロール内のすべてのメンバーを返します。

wls:/mydomain/serverConfig> listAppRoleMembers(appStripe="myApp", appRoleName="myRole")

4.6.7 grantPermission

新しいパーミッションを作成するオンライン・コマンドを示します。

4.6.7.1 説明

指定したコード・ベースおよびURLに対して新しいパーミッションを作成します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.7.2 構文

オプションの引数は、角カッコで囲まれています。

grantPermission([appStripe,] [codeBaseURL,] [principalClass,] [principalName,]permClass, [permTarget,] [permActions])

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
codeBaseURL	パーミッションのあるコードのURLを指定します。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。
permClass	permissionクラスの完全修飾名を指定します。
permTarget	利用可能であれば、パーミッション対象の名前を指定します。一部のパーミッションには、この属性を含むことができない場合があります。
permActions	付与されたアクションのカンマ区切りのリストを指定します。一部のパーミッションには、この属性が含まれない可能性があり、利用可能なアクションは、permissionクラスによって異なります。

4.6.7.3 例

次の呼出しは、指定したデータでアプリケーションの新しいパーミッション(アプリケーション・ストライプmyAppのアプリケーション)を作成します。

wls:/mydomain/serverConfig> grantPermission(appStripe="myApp",  
principalClass="my.custom.Principal",  principalName="manager",
permClass="java.security.AllPermission")

次の呼出しは、指定したデータでシステムの新しいパーミッションを作成します。

wls:/mydomain/serverConfig> grantPermission(principalClass="my.custom.Principal", principalName="manager",   
permClass="java.io.FilePermission", permTarget="/tmp/fileName.ext", 
permTarget="/tmp/fileName.ext", permActions="read,write")

4.6.8 revokePermission

パーミッションを削除するオンライン・コマンドを示します。

4.6.8.1 説明

指定したコード・ベースおよびURLのパーミッションを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.8.2 構文

オプションの引数は、角カッコで囲まれています。

revokePermission([appStripe,] [codeBaseURL,] [principalClass,] [principalName,]permClass, [permTarget,] [permActions])

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
codeBaseURL	パーミッションのあるコードのURLを指定します。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。
permClass	permissionクラスの完全修飾名を指定します。
permTarget	利用可能であれば、パーミッション対象の名前を指定します。一部のパーミッションには、この属性を含むことができない場合があります。
permActions	付与されたアクションのカンマ区切りのリストを指定します。一部のパーミッションには、この属性が含まれない可能性があり、利用可能なアクションは、permissionクラスによって異なります。

4.6.8.3 例

次の呼出しは、指定したデータのアプリケーションパーミッション(アプリケーション・ストライプmyAppのアプリケーション)を削除します。

wls:/mydomain/serverConfig> revokePermission(appStripe="myApp",  
principalClass="my.custom.Principal", principalName="manager", 
permClass="java.security.AllPermission")

次の呼出しは、システムの指定したデータのパーミッションを削除します。

wls:/mydomain/serverConfig> revokePermission(principalClass="my.custom.Principal", principalName="manager",  
permClass="java.io.FilePermission", permTarget="/tmp/fileName.ext", 
permActions="read,write")

4.6.9 listPermissions

指定したプリンシパルに付与したすべてのパーミッションを表示するオンライン・コマンドを示します。

4.6.9.1 説明

指定したプリンシパルに付与されたすべてのパーミッションを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.9.2 構文

オプションの引数は、角カッコで囲まれています。

listPermissions([appStripe,] principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。

4.6.9.3 例

次の呼出しは、アプリケーションmyAppのポリシーによってプリンシパルに付与したすべてのパーミッションを表示します。

wls:/mydomain/serverConfig> listPermissions(appStripe="myApp", principalClass="my.custom.Principal",principalName="manager")
                

次の呼出しは、システム・ポリシーによってプリンシパルに付与したすべてのパーミッションを表示します。

wls:/mydomain/serverConfig> listPermissions(principalClass="my.custom.Principal", principalName="manager")

4.6.10 deleteAppPolicies

指定したアプリケーション・ストライプのすべてのポリシーを削除するオンライン・コマンドを示します。

4.6.10.1 説明

指定したアプリケーション・ストライプのすべてのポリシーを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.10.2 構文

deleteAppPolicies(appStripe)

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。

4.6.10.3 例

次の呼出しは、アプリケーションmyAppのすべてのポリシーを削除します。

wls:/mydomain/serverConfig> deleteAppPolicies(appStripe="myApp")

4.6.11 migrateSecurityStore

アイデンティティ、ポリシー(アプリケーション固有、およびシステム)、資格証明、監査およびキーストア・サービス・アーティファクトをリポジトリ間で移行するオフライン・コマンド。

詳細は、Oracle Fusion Middlewareアプリケーション・セキュリティ・ガイドの次の項を参照してください。

• アイデンティティの移行

• ポリシーおよび資格証明の移行

• 監査情報の移行

• キーストア・サービス・アーティファクトの移行

4.6.11.1 説明

ID、アプリケーション特定ポリシーまたはシステム・ポリシーをソース・リポジトリから対象リポジトリに移動します。特定資格証明フォルダまたはすべての資格証明を移動します。

ソース・データおよび対象データの格納先リポジトリの種類は、コマンドに対して分かりやすく、ファイル・ベースおよびLDAPベース・リポジトリの任意の組合せを利用可能です(LDAPリポジトリが、OVDサーバーまたはOID LDAPサーバーのみ使用する必要があります)。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.11.2 構文

コマンドの構文は、移動されているポリシーのスコープ(システム特定またはアプリケーション特定または両方)によって異なります。

オプションの引数は、角カッコで囲まれています。

IDを移動するには、次の構文を使用します:

migrateSecurityStore(type="idStore", configFile, src, dst, [dstLdifFile])
                     

すべてのポリシー(すべてのアプリケーションのシステム特定およびアプリケーション特定ポリシー)を移動するには、次の構文を使用します

migrateSecurityStore(type="policyStore", configFile, src, 
dst,[overWrite,][preserveAppRoleGuid])

システム・ポリシーだけ移動するには、次の構文を使用します:

migrateSecurityStore(type="globalPolicies", configFile, src, dst, [overWrite])

1つのアプリケーションのアプリケーション特定ポリシーだけ移動するには、次の構文を使用します:

migrateSecurityStore(type="appPolicies", configFile,src, dst, srcApp 
[,dstApp] [,overWrite] [,migrateIdStoreMapping][,preserveAppRoleGuid] [,mode])

すべての資格証明を移動するには、次の構文を使用します:

migrateSecurityStore(type="credStore", configFile, src, dst, [overWrite])

資格証明フォルダを1つだけ移動するには、次の構文を使用します:

migrateSecurityStore(type="folderCred", configFile,src, dst, [srcFolder,]
[dstFolde,] [srcConfigFile,] [overWrite])

引数	定義
type	移動するポリシーのタイプを指定します。 IDを移動するには、idStoreに設定します。 すべてのポリシー(すべてのアプリケーションのシステム特定およびアプリケーション特定ポリシー)を移動するには、policyStoreに設定します。 システム・ポリシーだけを移動するには、globalPoliciesに設定します。 アプリケーション特定ポリシーだけを移動するには、appPoliciesに設定します。 すべての資格証明を移動するには、credStoreに設定します。 資格証明フォルダを1つだけ移動するには、folderCredに設定します。
configFile	コマンドが実行しているディレクトリに対して設定ファイルjps-config.xmlの場所を指定します。渡された設定ファイルは、実際のドメインの設定ファイルである必要はありませんが、これらのファイルを組み合せることだけで、移動するソース・リポジトリおよび宛先リポジトリを指定できます。
src	ソースのストアが指定されている引数configFileに渡された設定ファイル内のjpsコンテキストの名前を指定します。
dst	宛先のストアが指定されている引数configFileに渡された設定ファイル内の別のjpsコンテキストの名前を指定します。
srcApp	ポリシーが移動されているソース・アプリケーションの名前を指定します。
dstApp	ポリシーが書き込まれている対象アプリケーションの名前を指定します。指定しない場合、デフォルトは、ソース・アプリケーションの名前になります。
srcFolder	資格証明の移動先フォルダの名前を指定します。この引数はオプションです。指定しない場合、資格証明ストアにフォルダが1つのみ存在すると想定され、この引数のデフォルト値は、そのフォルダの名前になります。
dstFolder	ソース資格証明の移動先フォルダを指定します。この引数はオプションです。指定しない場合、デフォルトは、srcFolderに渡されたフォルダになります。
srcConfigFile	代替の設定ファイルの場所を指定します。代替の設定ファイルは、configFileに渡されたファイルに資格証明が設定されていないなど特定の場合に使用されます。この引数はオプションです。指定しない場合、デフォルトは、configFileに渡された値になります。指定する場合、configFileに渡された値が無視されます。
overWrite	移動されている対象と一致するデータ内のデータをソース・データと上書きするか、ソース・データにマージするかを指定します。オプションで、デフォルトはfalseです。一致するデータを上書きする場合、true設定します。一致するデータをマージする場合、falseに設定します。
migrateIdStoreMapping	アプリケーションのポリシーを移動するときにエンタープライズ・ポリシーの移動を行うか行わないかを指定します。オプションで、デフォルトはtrueです。アプリケーション・ポリシーの移動ときエンタープライズ・ポリシーの移動を行わない場合は、Falseに設定します。
dstLdifFile	LDIFファイルの作成先を指定します。宛先がLDAPベースIDストアの場合のみ必要です。LDIFファイルがLDAPサーバーにインポートされなく、使用しているLDAPサーバーに対して必要な属性を突き止めるためにこのファイルを変更した後、手動でインポートする必要があることに注意します。
preserveAppRoleGuid	ポリシーの移行でGUIDを保持するか再作成するかを指定します。オプションで、デフォルトはfalseです。GUIDを保持する場合はtrueに設定し、GUIDを再作成する場合はfalseに設定します。
mode	アプリケーション・ポリシーに重複するプリンシパルまたはパーミッションが見つかった場合、移行を停止し、エラーを表示するかどうかを指定します。laxに設定すると、重複する項目が見つかっても移行は続行され、重複する項目のうち1つだけが移行されて、その旨を知らせる警告がログに記録されます。strictに設定すると、重複する項目が見つかった場合、移行は強制的に停止されます。指定しない場合、この値はデフォルトのstrictに設定されます。

渡される引数に対しては、次の要求があります。

• ファイルjps-config.xmlが渡された場所に存在する必要があります。

• ファイルjps-config.xmlには、渡されたjpsコンテキストが含まれる必要があります。

• ソース・コンテキスト名および宛先コンテキスト名が異なる必要があります。コマンドは、これらの2つのコンテキストから移動に使用するソース・リポジトリおよび対象リポジトリの場所を決定します。

4.6.11.3 例

次の呼出しは、アプリケーションPolicyServlet1のファイル・ベース・ポリシーをアプリケーションPolicyServlet2のファイル・ベース・ポリシーに移行します。重複するプリンシパルまたはパーミッションが見つかっても移行は停止されず、重複する項目のうち1つだけが移行されて、重複する項目が見つかったことを知らせる警告がログに記録されます。

wls:/mydomain/serverConfig> migrateSecurityStore(type="appPolicies",  
configFile="jps-congif.xml", src="default1", dst="context2",
srcApp="PolicyServlet1", dstApp="PolicyServlet2", overWrite="true", mode="lax")
                

上記の呼出しは、次のものを仮定しています。

• ファイルjps-config.xmlは、コマンドが実行されているディレクトリ(現在のディレクトリ)にあります。

• このファイルには、次の要素が含まれています。

<serviceInstance name="policystore1.xml" provider="some.provider">
  <property name="location" value="jazn-data1.xml"/>
</serviceInstance>
<serviceInstance name="policystore2.xml" provider="some.provider">
  <property name="location" value="jazn-data2.xml"/>
</serviceInstance>
...
<jpsContext name="default1">
  <serviceInstanceRef ref="policystore1.xml"/>
  ...
</jpsContext>
<jpsContext name="context2">
  <serviceInstanceRef ref="policystore2.xml"/>
  ...
</jpsContext>

移動に対して使用されている2つのアプリケーションのファイル・ベース・ポリシーは、ファイルjazn-data1.xmlおよびjazn-data2.xmlに定義されており、表示されなく、現在のディレクトリに存在されていると仮定されます。

次の呼出しは、ファイル・ベース資格証明の1つの場所から別の場所への移動を示してます。

wls:/mydomain/serverConfig> migrateSecurityStore(type="credStore", configFile="jps-congif.xml", src="default1", dst="context2")
                

上記の呼出しは、次のものを仮定しています。

• ファイルjps-config.xmlは、コマンドが実行されているディレクトリ(現在のディレクトリ)にあります。

• このファイルには、次の要素が含まれています。

<serviceInstance name="credstore1" provider="some.provider">
  <property name="location" value="./credstore1/cwallet.sso"/>
</serviceInstance>
<serviceInstance name="credstore2" provider="some.provider">
  <property name="location" value="./credstore2/cwallet.sso"/>
</serviceInstance>
...
<jpsContext name="default1">
  <serviceInstanceRef ref="credstore1"/>
  ...
</jpsContext>
<jpsContext name="context2">
  <serviceInstanceRef ref="credstore2"/>
  ...
</jpsContext>

このコマンドとともに使用する詳細な構成の例については、『Oracle Fusion Middlewareアプリケーション・セキュリティ・ガイド』を参照してください。

4.6.12 updateCred

資格証明のタイプ、ユーザー名およびパスワードを変更するオンライン・コマンドを示します。

4.6.12.1 説明

指定したマップ名およびキー名の資格証明ストア内の資格証明のタイプ、ユーザー名、パスワード、URLおよびポート番号を変更します。このコマンドは、パスワード・タイプのみの資格証明にカプセル化されたデータを更新できます。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。コマンドが正常に実行されると、エラー・メッセージは表示されません。

4.6.12.2 構文

オプションの引数は、角カッコで囲まれています。

updateCred(map, key, user, password, [desc])

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。
user	資格証明ユーザー名を指定します。
password	資格証明のパスワードを指定します。
desc	資格証明を説明する文字列を指定します。

4.6.12.3 例

次の呼出しは、指定したデータでパスワード資格証明を更新します。

wls:/mydomain/serverConfig> updateCred(map="myMap", key="myKey", user="myUsr", 
password="myPassw", desc="updated passw cred to connect to app xyz")

4.6.13 createCred

ドメイン資格証明ストアに新しい資格証明を作成するオンライン・コマンドを示します。

4.6.13.1 説明

指定したマップ名、キー名、タイプ、ユーザー名およびパスワード、URLおよびポート番号のドメイン資格証明ストアに新しい資格証明を作成します。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。コマンドが正常に実行されると、エラー・メッセージは表示されません。

4.6.13.2 構文

オプションの引数は、角カッコで囲まれています。

createCred(map, key, user, password, [desc])

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。
user	資格証明ユーザー名を指定します。
password	資格証明のパスワードを指定します。
desc	資格証明を説明する文字列を指定します。

4.6.13.3 例

次の呼出しは、指定したデータで新しいパスワード資格証明を作成します。

wls:/mydomain/serverConfig> createCred(map="myMap, key="myKey", user="myUsr", 
password="myPassw", desc="updated usr name and passw to connect to app xyz")

4.6.14 deleteCred

ドメイン資格証明ストア内の資格証明を削除するオンライン・コマンドを示します。

4.6.14.1 説明

指定したマップ名およびキー名の資格証明をドメイン資格証明ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。コマンドが正常に実行されると、エラー・メッセージは表示されません。

4.6.14.2 構文

deleteCred(map,key)

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。

4.6.14.3 例

次の呼出しは、マップ名myMapおよびキー名myKeyの資格証明を削除します。

wls:/mydomain/serverConfig> deleteCred(map="myApp",key="myKey")

4.6.15 modifyBootStrapCredential

ブート・ストラップ資格証明ストアを更新するオフライン・コマンドを示します。

4.6.15.1 説明

指定したユーザー名およびパスワードでブート・ストラップ資格証明を更新します。エラーが発生した場合は、WLSTExceptionが返されます。

一般的に、次のシナリオの場合に使用されます: ドメイン・ポリシーおよび資格証明ストアはLDAPベースで、(LDAPサーバーに格納された)LDAPストアにアクセスする資格証明が変更されたとします。その後、このコマンドを使用して、ブート・ストラップ資格証明ストアにこれらの変更を設定できます。

4.6.15.2 構文

modifyBootStrapCredential(jpsConfigFile, username, password)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。
username	LDAPストア内のユーザーの識別名を指定します。
password	ユーザーのパスワードを指定します。

4.6.15.3 例

LDAPストアでは、識別された名cn=orcladminのユーザーのパスワードをwelcome1に変更しており、設定ファイルjps-config.xmlを現在のディレクトリに存在している場合、次の呼出しは、ブート・ストラップ資格証明ストア内のパスワードをwelcome1に変更します。

wls:/mydomain/serverConfig> modifyBootStrapCredential(jpsConfigFile='./jps-config.xml', username='cn=orcladmin', password='welcome1')

監査サービスに対する任意の出力を無視できます。

4.6.16 addBootStrapCredential

資格証明をブート・ストラップ資格証明ストアに追加するオフライン・コマンド。

4.6.16.1 説明

指定されたマップ、キー、ユーザー名およびユーザー・パスワードを持つパスワード資格証明を、JPS構成ファイルのデフォルトのJPSコンテキストで構成されたブートストラップ資格証明に追加します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.16.2 構文

addBootStrapCredential(jpsConfigFile, map, key, username, password)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。
map	追加する資格証明のマップを指定します。
key	追加する資格証明のキーを指定します。
username	追加する資格証明のユーザーの名前を指定します。
password	追加する資格証明のユーザーのパスワードを指定します。

4.6.16.3 例

次の呼出しは、資格証明をブート・ストラップ資格証明ストアに追加します。

wls:/mydomain/serverConfig> addBootStrapCredential(jpsConfigFile='./jps-config.xml', map='myMapName', key='myKeyName', username='myUser', password='myPassword')

4.6.17 exportEncryptionKey

ドメインのブートストラップ・ウォレットからファイルewallet.p12に暗号化鍵を抽出するオフライン・コマンド。

4.6.17.1 説明

ドメインの資格証明暗号化鍵をファイルewallet.p12に書き込みます。コマンドimportEncryptionKeyを使用してそのファイルからデータをインポートするには、このコマンドで渡されるパスワードを使用する必要があります。

4.6.17.2 構文

exportEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。
keyFilePath	ファイルewallet.p12の作成先となるディレクトリを指定します。このファイルのコンテンツは暗号化されており、keyFilePasswordに渡される値によって保護されていることに注意してください。
keyFilePassword	ファイルewallet.p12を保護するためのパスワードを指定します。このファイルをインポートする際は、これと同じパスワードを使用する必要があることに注意してください。

4.6.17.3 例

次の呼出しは、ディレクトリmyDirにファイルewallet.p12を書き込みます。

exportEncryptionKey(jpsConfigFile="pathName", keyFilePath="myDir" ,keyFilePassword="password")

4.6.18 importEncryptionKey

指定されたewallet.p12ファイルからドメインにキーをインポートするオフライン・コマンド。

4.6.18.1 説明

次の呼出しは、ファイルewallet.p12からドメインに暗号化鍵をインポートします。渡されるパスワードは、コマンドexportEncryptionKeyを使用してファイルを作成する際に使用されたものと同じである必要があります。

4.6.18.2 構文

importEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。
keyFilePath	ewallet.p12の書込み先となるディレクトリを指定します。
keyFilePassword	ファイルewallet.p12の生成時に使用されたパスワードを指定します。

4.6.18.3 例

importEncryptionKey(jpsConfigFile="pathName", keyFilePath="dirloc" ,keyFilePassword="password")

4.6.19 restoreEncryptionKey

ドメイン資格証明暗号化鍵をリストアするオフライン・コマンド。

4.6.19.1 説明

ドメイン・ブートストラップ・キーの状態を、importEncryptionKeyの実行前の状態にリストアします。

4.6.19.2 構文

restoreEncryptionKey(jpsConfigFile)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。

4.6.19.3 例

restoreEncryptionKey(jpsConfigFile="pathName")

4.6.20 rollOverEncryptionKey

新規のドメイン資格証明暗号化鍵を作成するオフライン・コマンド。

4.6.20.1 説明

新規の資格証明暗号化鍵をドメイン・ウォレットに作成します。次の重要な点に注意してください。

• ドメインの管理サーバーから実行する必要があります。このスクリプトの起動後にサーバーの再起動は必要ありません。

• ドメインがセキュリティ・ストアにアクセスしている唯一のドメインである場合は、他に必要な操作はありません。

• ただし、2つ以上のドメインがセキュリティ・ストアを共有している場合は、exportEncryptionKeyおよびimportEncryptionKeyスクリプトを使用して、スクリプトが実行されたドメインから新しく生成された鍵をエクスポートし、セキュリティ・ストアを共有しているその他のドメインそれぞれにインポートする必要があります。

• WebSphereプラットフォームでのスクリプト名はOpss.rollOverEncryptionKeyです。

4.6.20.2 構文

rollOverEncryptionKey(jpsConfigFile)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。

4.6.20.3 例

rollOverEncryptionKey(jpsConfigFile="pathName")

4.6.21 reassociateSecurityStore

セキュリティ・ストアをリポジトリ間で移行するオンライン・コマンド。

詳細は、Oracle Fusion Middlewareアプリケーション・セキュリティ・ガイドの、reassociateSecurityStoreの項を参照してください。

4.6.22 upgradeSecurityStore

リリース10.1.xセキュリティ・データをリリース11セキュリティ・データに移動するオフライン・コマンドを示します。

詳細は、Oracle Fusion Middlewareアプリケーション・セキュリティ・ガイドの、upgradeSecurityStoreによるアップグレードの項を参照してください。

4.6.23 createResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアに新しいリソース・タイプを作成するオンライン・コマンド。

4.6.23.1 説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアに、指定された名前、表示名、説明およびアクションを持つ新しいリソース・タイプ要素を作成します。オプションの引数は、角カッコで囲まれています。それ以外のすべての引数は必須です。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.23.2 構文

オプションの引数は、角カッコで囲まれています。

createResourceType(appStripe, resourceTypeName, displayName, description [, provider] [, matcher], actions [, delimeter])

引数	定義
appStripe	リソース・タイプの挿入対象のアプリケーション・ストライプを指定します。
resourceTypeName	挿入するリソース・タイプの名前を指定します。
displayName	UIガジェットで使用されるリソース・タイプの名前を指定します。
description	リソース・タイプの簡単な説明を指定します。
provider	リソース・タイプのプロバイダを指定します。
matchere	リソース・タイプのクラスを指定します。指定しない場合、この値はデフォルトのoracle.security.jps.ResourcePermissionに設定されます。
actions	このリソース・タイプのインスタンスで許可されるアクションを指定します。
delimeter	アクションのリストでデリミタとして使用する文字を指定します。指定しない場合、この値はデフォルトのカンマ(,)に設定されます。

4.6.23.3 例

次の呼出しは、ストライプmyApplication内に、アクションBWPrintおよびColorPrint(デリミタとしてセミコロンを使用します)を持つリソース・タイプを作成します。

wls:/mydomain/serverConfig> createResourceType(appStripe="myApplication", 
resourceTypeName="resTypeName", displayName="displName", description="A resource
type", provider="Printer", matcher="com.printer.Printer",
actions="BWPrint;ColorPrint" [, delimeter=";"])

4.6.24 getResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプをフェッチするオンライン・コマンド。

4.6.24.1 説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリの関連パラメータを取得します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.24.2 構文

getResourceType(appStripe, resourceTypeName)

引数	定義
appStripe	リソース・タイプのフェッチ元となるアプリケーション・ストライプを指定します。
resourceTypeName	フェッチするリソース・タイプの名前を指定します。

4.6.24.3 例

次の呼出しは、ストライプmyApplicationからリソース・タイプmyResTypeをフェッチします。

wls:/mydomain/serverConfig> getResourceType(appStripe="myApplication", resourceTypeName="myResType")

4.6.25 deleteResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプを削除するオンライン・コマンド。

4.6.25.1 説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

4.6.25.2 構文

deleteResourceType(appStripe, resourceTypeName)

引数	定義
appStripe	リソース・タイプの削除元となるアプリケーション・ストライプを指定します。
resourceTypeName	削除するリソース・タイプの名前を指定します。

4.6.25.3 例

次の呼出しは、ストライプmyApplicationからリソース・タイプmyResTypeを削除します。

wls:/mydomain/serverConfig> deleteResourceType(appStripe="myApplication", resourceTypeName="myResType")

4.6.26 listSecurityStoreInfo

ドメイン・セキュリティ・ストアのタイプ、場所および管理ユーザーを一覧表示するオフライン・コマンド。

4.6.26.1 説明

スクリプトはオフライン・モードで実行され、OPSSセキュリティ・ストアのタイプ(ファイル、OIDまたはDB)、場所、およびアクセスを許可されているユーザー(通常はセキュリティ管理者)を出力します。

4.6.26.2 構文

listSecurityStoreInfo(domainConfig="configFilePath")

引数	定義
domainConfig	OPSS構成ファイルjps-config.xmlへの完全絶対パスを指定します。渡されるディレクトリには、ファイルjps-config-jse.xmlも含まれている必要があります。

4.6.26.3 例

次の呼出しは、OPSSポリシー・ストアのタイプ、場所および管理ユーザーを戻します。

wls:/mydomain/serverConfig> listSecurityStoreInfo(domainConfig="/home/myConfigPathDirectory/config/fmwconfig")

4.6.27 listAppStripes

ポリシー・ストア内のアプリケーション・ストライプを一覧表示するオンラインまたはオフライン・コマンド。

4.6.27.1 説明

このスクリプトは、オフライン・モードまたはオンライン・モードで実行できます。オフライン・モードで実行する場合は、構成ファイルを渡す必要があります。渡された構成ファイルのデフォルト・コンテキストで構成によって参照されるポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。デフォルトの構成には、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。オンライン・モードで実行する場合は、構成ファイルを渡さないでください。接続しているドメインのポリシー・ストア内のストライプが一覧表示されます。いずれのモードでも、正規表現が渡されると、その正規表現に一致する名前を持つアプリケーション・ストライプが一覧表示されます。それ以外の場合は、すべてのアプリケーション・ストライプが一覧表示されます。

このコマンドがDBベースのストアへの再関連付けの後にオフライン・モードで使用される場合、再関連付けで生成された構成ファイルを手動で編集する必要があります。

4.6.27.2 構文

listAppStripes([configFile="configFileName"] [, regularExpression="aRegExp"])

引数	定義
configFile	OPSS構成ファイルへのパスを指定します。オプション。指定した場合、スクリプトはオフラインで実行されます。指定された構成ファイルのデフォルト・コンテキストに、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。指定しない場合、スクリプトはオンラインで実行され、ポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。
regularExpression	正規表現を指定します。この正規表現に一致するストライプ名が戻されます。オプション。指定しない場合、すべての名前が一致します。サブストリングに一致させるには、文字*を使用します。

4.6.27.3 例

次の(オンライン)呼出しは、ポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes

次の(オフライン)呼出しは、指定された構成ファイルのデフォルト・コンテキストで参照されるポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(configFile=" 
/home/myFile/jps-config.xml")

次の(オンライン)呼出しは、接頭辞Appを含むアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(regularExpression="App*")

4.6.28 listCodeSourcePermissions

グローバル・ポリシーのソース・コードに割り当てられている権限を一覧表示するオンライン・コマンド。

4.6.28.1 説明

このコマンドによって、グローバル・ポリシーのコードベース権限の一覧表示が可能になります。

4.6.28.2 構文

listCodeSourcePermissions([codeBase="codeUrl"])

引数	定義
codeBaseURL	権限受領者のコードベースURL名を指定します。

4.6.28.3 例

次の呼出しは、すべてのグローバル・ポリシーのコード・ソースに割り当てられたリスト権限を戻します。

wls:/mydomain/serverConfig> listCodeSourcePermissions(codeBaseURL="file:/tmp/lib/myJars.jar")

4.6.29 createResource

新しいリソースを作成するオンライン・コマンド。

4.6.29.1 説明

指定されたアプリケーション・ストライプ内に、指定されたタイプのリソースを作成します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

4.6.29.2 構文

createResource(appStripe="appStripeName", name="resName", type="resTypeName" [,-displayName="dispName"] [,-description="descript"])

引数	定義
appStripe	リソースの作成対象のアプリケーション・ストライプを指定します。
name	作成するリソースの名前を指定します。
type	作成するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。
displayName	作成するリソースの表示名を指定します。オプション。
description	作成するリソースの説明を指定します。オプション。

4.6.29.3 例

次の呼出しは、ストライプmyApplication内にリソースmyResourceを作成します。

wls:/mydomain/serverConfig> createResource(appStripe="myApplication", name="myResource", type="myResType", displayName="myNewResource")

4.6.30 deleteResource

リソースを削除するオンライン・コマンド。

4.6.30.1 説明

アプリケーション・ストライプ内の資格からリソースおよびそのすべての参照を削除します。このコマンドは、カスケード削除を実行します。資格が1つのリソースのみを参照している場合は、その資格を削除し、それ以外の場合は、渡されたタイプのリソース・アクションを資格から削除します。

4.6.30.2 構文

deleteResource(appStripe="appStripeName", name="resName", type="resTypeName")

引数	定義
appStripe	リソースの削除対象のアプリケーション・ストライプを指定します。
name	削除するリソースの名前を指定します。
type	削除するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

4.6.30.3 例

次の呼出しは、ストライプmyApplication内のリソースmyResourceを削除します。

wls:/mydomain/serverConfig> deleteResource(appStripe="myApplication", name="myResource", type="myResType")

4.6.31 listResources

指定されたアプリケーション・ストライプ内のリソースを一覧表示するオンライン・コマンド。

4.6.31.1 説明

リソース・タイプを指定した場合、指定されたリソース・タイプのすべてのリソースが一覧表示されます。それ以外の場合は、すべてのタイプのすべてのリソースが一覧表示されます。

4.6.31.2 構文

listResources(appStripe="appStripeName" [,type="resTypeName"])

引数	定義
appStripe	リソースの一覧表示対象のアプリケーション・ストライプを指定します。
type	一覧表示するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

4.6.31.3 例

次の呼出しは、ストライプmyApplication内のタイプmyResTypeのリソースをすべて一覧表示します。

wls:/mydomain/serverConfig> listResources(appStripe="myApplication", type="myResType")

4.6.32 listResourceActions

資格のリソースとアクションを一覧表示するオンライン・コマンド。

4.6.32.1 説明

アプリケーション・ストライプ内の資格のリソースとアクションを一覧表示します。

4.6.32.2 構文

listResourceActions(appStripe="appStripeName", permSetName="entitlementName")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
permSetName	リソースとアクションを一覧表示する資格の名前を指定します。

4.6.32.3 例

次の呼出しは、ストライプmyApplication内の資格myEntitlementのリソースとアクションを一覧表示します。

wls:/mydomain/serverConfig> listResourceActions(appStripe="myApplication", permSetName="myEntitlement")

4.6.33 createEntitlement

新しい資格を作成するオンライン・コマンド。

4.6.33.1 説明

指定されたアプリケーション・ストライプに、1つのリソースとアクションのリストを持つ新しい資格を作成します。既存の資格にリソースを追加するにはaddResourceToEntitlementを使用し、既存の資格からリソースを削除するにはrevokeResourceFromEntitlementを使用します。

4.6.33.2 構文

createEntitlement(appStripe="appStripeName", name="entitlementName", resourceName="resName", actions="actionList" [,-displayName="dispName"] [,-description="descript"])

引数	定義
appStripe	資格の作成対象のアプリケーション・ストライプを指定します。
name	作成する資格の名前を指定します。
resourceName	作成する資格の1つのリソース・メンバーの名前を指定します。
actions	リソースresourceNameのアクションのカンマ区切りのリストを指定します。
displayName	作成するリソースの表示名を指定します。オプション。
description	作成する資格の説明を指定します。オプション。

4.6.33.3 例

次の呼出しは、ストライプmyApplication内にリソースmyResourceのみを持つ資格myEntitlementを作成します。

wls:/mydomain/serverConfig> createEntitlement(appStripe="myApplication", name="myEntitlement", resourceName="myResource", actions="read,write")

4.6.34 getEntitlement

資格を取得するオンライン・コマンド。

4.6.34.1 説明

アプリケーション・ストライプ内の資格の名前、表示名およびすべてのリソース(とそれらの資格)を戻します。

4.6.34.2 構文

getEntitlement(appStripe="appStripeName", name="entitlementName")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	アクセスする資格の名前を指定します。

4.6.34.3 例

次の呼出しは、ストライプmyApplication内の資格myEntitlementの情報を戻します。

wls:/mydomain/serverConfig> getEntitlement(appStripe="myApplication", name="myEntitlement")

4.6.35 deleteEntitlement

資格を削除するオンライン・コマンド。

4.6.35.1 説明

指定されたアプリケーション・ストライプ内の資格を削除します。アプリケーション・ストライプ内の指定された資格へのすべての参照を削除することで、カスケード削除を実行します。

4.6.35.2 構文

deleteEntitlement(appStripe="appStripeName", name="entitlementName")

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
name	削除する資格の名前を指定します。

4.6.35.3 例

次の呼出しは、ストライプmyApplication内の資格myEntitlementを削除します。

wls:/mydomain/serverConfig> deleteEntitlement(appStripe="myApplication", name="myEntitlement")

4.6.36 addResourceToEntitlement

指定されたアクションを持つリソースを資格に追加するオンライン・コマンド。

4.6.36.1 説明

指定されたアプリケーション・ストライプ内の資格に、指定されたアクションを持つリソースを追加します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

4.6.36.2 構文

addResourceToEntitlement(appStripe="appStripeName", name="entName", resourceName="resName",actions="actionList")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	変更する資格の名前を指定します。
resourceName	追加するリソースの名前を指定します。
resourceType	追加するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。
actions	追加されるリソースのアクションのカンマ区切りのリストを指定します。

4.6.36.3 例

次の呼出しは、アプリケーション・ストライプmyApplication内の資格myEntitlementにリソースmyResourceを追加します。

wls:/mydomain/serverConfig> addResourceToEntitlement(appStripe="myApplication", 
name="myEntitlement", resourceName="myResource", resourceType="myResType", 
actions="view,edit")

4.6.37 revokeResourceFromEntitlement

資格からリソースを削除するオンライン・コマンド。

4.6.37.1 説明

指定されたアプリケーション・ストライプ内の資格からリソースを削除します。

4.6.37.2 構文

revokeResourceFromEntitlement(appStripe="appStripeName", name="entName", resourceName="resName", resourceType="resTypeName", actions="actionList")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	変更する資格の名前を指定します。
resourceName	削除するリソースの名前を指定します。
resourceType	削除するリソースのタイプを指定します。
actions	削除するアクションのカンマ区切りのリストを指定します。

4.6.37.3 例

次の呼出しは、ストライプmyApplication内の資格myEntitlementからリソースmyResourceを削除します。

wls:/mydomain/serverConfig> revokeResourceFromEntitlement(appStripe="myApplication", name="myEntitlement", 
resourceName="myResource", resourceType="myResType", actions="view,edit")

4.6.38 listEntitlements

アプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

4.6.38.1 説明

アプリケーション・ストライプ内のすべての資格を一覧表示します。リソース名およびリソース・タイプを指定した場合、指定されたリソース名に一致する、指定されたタイプのリソースを持つ資格が一覧表示されます。それ以外の場合は、アプリケーション・ストライプ内のすべての資格が一覧表示されます。

4.6.38.2 構文

listEntitlements(appStripe="appStripeName" [,resourceTypeName="resTypeName", resourceName="resName"])

引数	定義
appStripe	資格の一覧表示対象のアプリケーション・ストライプを指定します。
resourceTypeName	一覧表示するリソースのタイプの名前を指定します。オプション。
resourceName	一致させるリソースの名前を指定します。オプション。

4.6.38.3 例

次の呼出しは、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication")

次の呼出しは、リソース・タイプmyResType、およびリソース名がmyResNameに一致するリソースを含む、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication", resourceTypeName="myResType", resourceName="myResName") 

4.6.39 grantEntitlement

新しい資格を作成するオンライン・コマンド。

4.6.39.1 説明

指定されたアプリケーション・ストライプ内に、指定されたプリンシパルを持つ新しい資格を作成します。

4.6.39.2 構文

grantEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数	定義
appStripe	資格の作成対象のアプリケーション・ストライプを指定します。
principalClass	プリンシパルに関連付けられているクラスを指定します。
principalName	資格が付与されるプリンシパルの名前を指定します。
permSetName	作成する資格の名前を指定します。

4.6.39.3 例

次の呼出しは、ストライプmyApplication内に資格myEntitlementを作成します。

wls:/mydomain/serverConfig> grantEntitlement(appStripe="myApplication", 
principalClass="oracle.security.jps.service.policystore.ApplicationRole", 
principalName="myPrincipalName", permSetName="myEntitlement")

4.6.40 revokeEntitlement

資格を削除するオンライン・コマンド。

4.6.40.1 説明

資格を削除し、指定されたアプリケーション・ストライプ内のプリンシパルからその資格を取り消します。

4.6.40.2 構文

revokeEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
principalClass	プリンシパルに関連付けられているクラスを指定します。
principalName	資格が取り消されるプリンシパルの名前を指定します。
permSetName	削除する資格の名前を指定します。

4.6.40.3 例

次の呼出しは、ストライプmyApplication内の資格myEntitlementを削除します。

wls:/mydomain/serverConfig> revokeEntitlement(appStripe="myApplication", 
principalClass="oracle.security.jps.service.policystore.ApplicationRole", 
principalName="myPrincipalName", permSetName="myEntitlement")

4.6.41 listResourceTypes

リソース・タイプを一覧表示するオンライン・コマンド。

4.6.41.1 説明

指定されたアプリケーション・ストライプ内のすべてのリソース・タイプを一覧表示します。

4.6.41.2 構文

listResourceTypes(appStripe="appStripeName")

引数	定義
appStripe	リソース・タイプが存在するアプリケーション・ストライプを指定します。

4.6.41.3 例

次の呼出しは、ストライプmyApplication内のすべてのリソース・タイプを一覧表示します。

wls:/mydomain/serverConfig> listResourceTypes(appStripe="myApplication")

4.6.42 updateTrustServiceConfig

ドメイン・トラスト・サービス構成値を更新するオンライン・コマンド。

4.6.42.1 説明

ファイルで渡された値でトラスト・サービス構成を更新します。

4.6.42.2 構文

updateTrustServiceConfig([providerName="<the proverde name>",] propsFile="<path to the property file>")

引数	定義
providerName	トラスト・サービス・プロバイダ名を指定します。オプション。指定しない場合、この値はデフォルトのtrust.provider.embeddedに設定されます。
propsFile	プロパティ・ファイルへのパスを指定します。必須。

4.6.42.3 例

次の呼出しは、プロパティ・ファイルmyPropsで指定された値でトラスト・サービス・ストアを更新します。

wls:/mydomain/serverConfig> updateTrustServiceConfig(propsFile="myProps")

プロパティ・ファイルのサンプルは次のとおりです。

trust.keystoreType=KSS
trust.keyStoreName=kss://<stripeName>/<keystoreName>
trust.trustStoreName=kss://<stripeName>/<truststoreName>
trust.aliasName=<aliasName>
trust.issuerName=<aliasName>

可能なタイプはKSSまたはJKSです。プロパティが空の文字列に設定されている場合、そのプロパティはトラスト・サービス構成から削除されます。

4.7 Oracle Access Managerコマンド

表4-6に示されているWLSTコマンドを使用して、認可プロバイダ、アイデンティティ・アサーション・プロバイダ、SSOプロバイダなど、Oracle Access Manager (OAM)関連コンポーネントの管理に加えて、メトリックおよびデプロイメント・トポロジの表示や、Oracle Access Managerサーバーとエージェントの構成の管理およびログ出力設定の管理を行います。

表4-6 WLST Oracle Access Managerコマンド

このコマンドを使用します...	次を行うには...	WLSTの使用...
listOAMAuthnProviderParams	Oracle Access Manager認証プロバイダまたはアイデンティティ・アサーション・プロバイダに設定されているパラメータを一覧表示します。	オンライン
createOAMIdentityAsserter	新規のアイデンティティ・アサーション・プロバイダを作成します。	オンライン
updateOAMIdentityAsserter	既存のアイデンティティ・アサーション・プロバイダを更新します。	オンライン
createOAMAuthenticator	新規のオーセンティケータを作成します。	オンライン
deleteOAMAuthnProvider	既存の認証プロバイダを削除します。	オンライン
updateOAMAuthenticator	既存のオーセンティケータを更新します。	オンライン
addOAMSSOProvider	新規のSSOプロバイダを追加します。	オンライン
displayTopology	デプロイ済のOracle Access Managerサーバーの詳細を一覧表示します。	オンライン オフライン
displayMetrics	Oracle Access Managerサーバーおよびドメインのパフォーマンス・メトリックを表示します。	オンライン
displayOamServer	Oracle Access Managerサーバー構成の詳細を表示します。	オンライン オフライン
createOamServer	Oracle Access Managerサーバー構成のエントリを作成します。	オンライン オフライン
editOamServer	Oracle Access Managerサーバー構成のエントリを編集します。	オンライン オフライン
deleteOamServer	指定されたOracle Access Managerサーバー構成を削除します。	オンライン オフライン
displayOssoAgent	OSSOエージェント構成の詳細を表示します。	オンライン オフライン
editOssoAgent	OSSOエージェント構成の詳細を編集します。	オンライン オフライン
deleteOssoAgent	指定されたOSSOエージェント構成を削除します。	オンライン オフライン
displayWebgateAgent	Webゲート・エージェント構成の詳細を表示します。	オンライン オフライン
editWebgateAgent	10g Webゲート・エージェントの登録の詳細を編集します。	オンライン オフライン
deleteWebgateAgent	指定された10g Webゲート・エージェント構成を削除します。	オンライン オフライン
changeLoggerSetting	ロガー設定を変更します。	オンライン オフライン
changeConfigDataEncryptionKey	構成データ暗号化鍵を再生成し、データを再暗号化します。	オンライン オフライン
displayUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を表示します。	オンライン オフライン
editUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を編集します。	オンライン オフライン
createUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を作成します。	オンライン オフライン
deleteUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を削除します。	オンライン オフライン
configRequestCacheType	SSOサーバー・リクエスト・キャッシュ・タイプを構成します。	オンライン オフライン
displayRequestCacheType	SSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。	オンライン オフライン
exportPolicy	Oracle Access Managerポリシー・データを、テスト(ソース)から中間Oracle Access Managerファイルにエクスポートします。	オンライン
importPolicy	Oracle Access Managerポリシー・データを、指定されたOracle Access Managerファイルからインポートします。	オンライン
importPolicyDelta	Oracle Access Managerポリシー変更を、指定されたOracle Access Managerファイルからインポートします。	オンライン
migratePartnersToProd	パートナを、ソースOracle Access Managerサーバーから指定されたターゲットOracle Access Managerサーバーに移行します。	オンライン
exportPartners	Oracle Access Managerパートナを、ソースから指定された中間Oracle Access Managerファイルにエクスポートします。	オンライン
importPartners	Oracle Access Managerパートナを、指定された中間Oracle Access Managerファイルからインポートします。	オンライン
configureOAAM	Oracle Access ManagerとOracle Adaptive Access Managerの基本的な統合を構成します。	オンライン
registerOIFDAPPartner	Oracle Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。	オンライン オフライン
enableCoexistMode	共存モードを有効にします。	オンライン
disableCoexistMode	共存モードを無効にします。	オンライン
editGITOValues	GITO構成パラメータを編集します。	オンライン オフライン
editWebgate11gAgent	11g Webゲートの登録を編集します。	オンライン オフライン
deleteWebgate11gAgent	11g Webゲート・エージェントの登録を削除します。	オンライン オフライン
displayWebgate11gAgent	11g Webゲート・エージェントの登録を表示します。	オンライン オフライン
displayOAMMetrics	OAMサーバーのメトリックを表示します。	オンライン オフライン
updateOIMHostPort	Oracle Access Managerとの統合時にOracle Identity Manager構成を更新します。	オンライン オフライン
configureOIM	Oracle Access Managerとの統合時にOracle Identity Manager固有のエージェントの登録を作成します。	オンライン
updateOSSOResponseCookieConfig	OSSOプロキシ・レスポンスCookie設定を更新します。	オンライン オフライン
deleteOSSOResponseCookieConfig	OSSOプロキシ・レスポンスCookie設定を削除します。	オンライン オフライン
displaySimpleModeGlobalPassphrase	システム構成から簡易モードのグローバル・パスフレーズを平文で表示します。	オンライン
exportSelectedPartners	指定された中間OAMファイルに、選択されたOAMパートナをエクスポートします。	オンライン
migrateArtifacts	入力アーティファクト・ファイルに基づいてアーティファクトを移行します。	オンライン
registerThirdPartyTAPPartner	任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。	オンライン

4.7.1 listOAMAuthnProviderParams

ドメインのオーセンティケータまたはアイデンティティ・アサーション・プロバイダで有効なパラメータの値を一覧表示するオンライン・コマンド。

4.7.1.1 説明

指定されたOracle Access Managerオーセンティケータまたはアイデンティティ・アサーション・プロバイダに設定されたパラメータの値を一覧表示します。エラーが発生した場合は、WLSTExceptionが返されます。

4.7.1.2 構文

listOAMAuthnProviderParams(name)

引数	定義
name	オーセンティケータまたはアイデンティティ・アサーション・プロバイダの名前を指定します。

4.7.1.3 例

次の呼出しは、myIdAsserterという名前のアサーション・プロバイダに設定されたパラメータおよび値を一覧表示します。

listOAMAuthnProviderParams(name="myIdAsserter")

4.7.2 createOAMIdentityAsserter

現在のドメインにOracle Access Managerアイデンティティ・アサーション・プロバイダを作成するオンライン・コマンド。

4.7.2.1 説明

現在のドメインに指定した名前のアイデンティティ・アサーション・プロバイダを作成します。このコマンドを実行する前に、現在のドメインにすでに構成されているOracle Access Managerアイデンティティ・アサーション・プロバイダがないことを確認してください。エラーが発生した場合は、WLSTExceptionが返されます。

4.7.2.2 構文

createOAMIdentityAsserter(name)

引数	定義
name	新規のアイデンティティ・アサーション・プロバイダの名前を指定します。名前が指定されない場合は、デフォルトでOAMIdentityAsserterに設定されます。

4.7.2.3 例

次の呼出しは、OAMIdentityAsserterという名前の新規のアイデンティティ・アサーション・プロバイダを作成します。

createOAMIdentityAsserter(name="OAMIdentityAsserter")

4.7.3 updateOAMIdentityAsserter

現在のドメインのOracle Access Managerアイデンティティ・アサーション・プロバイダのパラメータ値を更新するオンライン・コマンド。

4.7.3.1 説明

ドメインのOracle Access Managerアイデンティティ・アサーション・プロバイダの指定されたパラメータの値を更新します。エラーが発生した場合は、WLSTExceptionが返されます。

4.7.3.2 構文

updateOAMIdentityAsserter(name, paramNameValueList)

引数	定義
name	パラメータ値を更新するOracle Access Managerアイデンティティ・アサーション・プロバイダの名前を指定します。
paramNameValueList	更新するパラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName="paramValue" 次のパラメータ名のみを更新できます。 accessGateName: オーセンティケータによって使用されるアクセス・ゲートの名前です。 accessGatePwd: オーセンティケータによって使用されるアクセス・ゲートへのパスワードです。 pAccessServer: プライマリ・アクセス・サーバーの名前です。値は、hostName:portNumberの形式にする必要があります。 sAccessServer: セカンダリ・アクセス・サーバーの名前です。値は、hostName:portNumberの形式にする必要があります。 transportSecurity: アクセス・ゲートとOAMアクセス・サーバーの間の通信モードです。 keystorePwd: ドメイン・キー・ストアにアクセスするためのパスワードです。 keystorePath: オーセンティケータとOAMアクセス・サーバーの間のSSL通信に使用するJKSキー・ストアの絶対パスです。 simpleModePassphrase: 簡易通信モードでアクセス・ゲートとOAM Access Serverが共有するパスワードです。 truststorePath: オーセンティケータとOAMアクセス・サーバーの間のSSL通信に使用するJKSトラスト・ストアの絶対パスです。 poolMaxConnections: OAMサーバー接続プールの接続の最大数です。 poolMinConnections: OAMサーバー接続プールの接続の最小数です。 ssoHeaderName: SSOヘッダー名です。 controlFlag: ドメイン内のすべてのオーセンティケータ間の依存性を設定するJAAS制御フラグです。使用できる値は、REQUIRED、SUFFICIENT、REQUISITEまたはOPTIONALのみです。 appDomain: アプリケーション・ドメインの名前です。

4.7.3.3 例

次の呼出しは、myIdAsserterという名前のOracle Access Managerアイデンティティ・アサーション・プロバイダのパラメータaccessGateName、accessGatePwd、pAccessServerおよびssoHeaderNameを更新します。

updateOAMIdentityAsserter(name="myIdAsserter", 
accessGateName="OAM IAP AccessGate", accessGatePwd="welcome1", 
pAccessServer="myhost.domain.com:5543", ssoHeaderName="OAM_SSO_HEADER")

4.7.4 createOAMAuthenticator

現在のドメインにOracle Access Managerオーセンティケータを作成するオンライン・コマンド。

4.7.4.1 説明

現在のドメインに指定した名前のOracle Access Managerオーセンティケータを作成します。このコマンドを実行する前に、デフォルトのセキュリティ・ドメインにすでに構成されているOracle Access Managerオーセンティケータがないことを確認してください。エラーが発生した場合は、WLSTExceptionが返されます。

4.7.4.2 構文

createOAMAuthenticator(name)

引数	定義
name	デフォルト・ドメインの新規の認証プロバイダの名前を指定します。名前が指定されない場合は、デフォルトでOAMAuthenticatorに設定されます。

4.7.4.3 例

次の呼出しは、OAMAuthenticatorという名前の新規の認証プロバイダを作成します。

createOAMAuthenticator(name="OAMAuthenticator")

4.7.5 deleteOAMAuthnProvider

現在のドメインからOAMオーセンティケータを削除するオンライン・コマンド。

4.7.5.1 説明

現在のドメインから指定した名前のOAMオーセンティケータを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

4.7.5.2 構文

deleteOAMAuthnProvider(name)

引数	定義
name	削除する認証プロバイダの名前を指定します。

4.7.5.3 例

次の呼出しは、オーセンティケータmyAuthenticatorを削除します。

deleteOAMAuthnProvider(name="myAuthenticator")

4.7.6 updateOAMAuthenticator

現在のドメインのOracle Access Managerオーセンティケータのパラメータ値を更新するオンライン・コマンド。

4.7.6.1 説明

ドメインのOracle Access Managerオーセンティケータの指定されたパラメータの値を更新します。エラーが発生した場合は、WLSTExceptionが返されます。

4.7.6.2 構文

updateOAMAuthenticator(name, paramNameValueList)

引数	定義
name	パラメータ値を更新するOracle Access Managerオーセンティケータの名前を指定します。
paramNameValueList	更新するパラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' 次のパラメータ名のみを更新できます。 accessGateName: オーセンティケータによって使用されるアクセス・ゲートの名前です。 accessGatePwd: オーセンティケータによって使用されるアクセス・ゲートへのパスワードです。 pAccessServer: プライマリ・アクセス・サーバーの名前です。値は、hostName:portNumberの形式にする必要があります。 sAccessServer: セカンダリ・アクセス・サーバーの名前です。値は、hostName:portNumberの形式にする必要があります。 transportSecurity: アクセス・ゲートとOAMアクセス・サーバーの間の通信モード(オープン、簡易または証明書)です。 keystorePwd: ドメイン・キー・ストアにアクセスするためのパスワードです。 keystorePath: オーセンティケータとOAMアクセス・サーバーの間のSSL通信に使用するJKSキー・ストアの絶対パスです。 simpleModePassphrase: 簡易通信モードでアクセス・ゲートとOAM Access Serverが共有するパスワードです。 truststorePath: オーセンティケータとOAMアクセス・サーバーの間のSSL通信に使用するJKSトラスト・ストアの絶対パスです。 poolMaxConnections: OAMサーバー接続プールの接続の最大数です。 poolMinConnections: OAMサーバー接続プールの接続の最小数です。 useRetNameAsPrincipal: OAMオーセンティケータから取得したユーザー名を、サブジェクトでプリンシパルの名前として使用するかどうかを指定します。 controlFlag: ドメイン内のすべてのオーセンティケータ間の依存性を設定するJAAS制御フラグです。使用できる値は、REQUIRED、SUFFICIENT、REQUISITEまたはOPTIONALのみです。 appDomain: アプリケーション・ドメインの名前です。

4.7.6.3 例

次の呼出しは、myAuthenticatorという名前のOracle Access ManagerオーセンティケータのパラメータaccessGateName、accessGatePwdおよびpAccessServerを更新します。

updateOAMAuthenticator(name="myAuthenticator", 
accessGateName="OAM AP AccessGate", accessGatePwd="welcome1",
pAccessServer="myhost.domain.com:5543")

4.7.7 addOAMSSOProvider

指定されたログインURI、ログアウトURIおよび自動ログインURIを持つOracle Access Manager SSOプロバイダを追加するオンライン・コマンド。

4.7.7.1 説明

指定されたログインURI、ログアウトURIおよび自動ログインURIを持つSSOプロバイダを追加します。このコマンドは、必要なプロパティを持つOracle Access Manager SSOサービス・インスタンスを追加することにより、ドメインjps-config.xmlを変更します。エラーが発生した場合は、WLSTExceptionが返されます。

4.7.7.2 構文

addOAMSSOProvider(loginuri, logouturi, autologinuri, beginimpuri, endimpuri)

引数	定義
loginuri	必須。ログイン・ページのURIを指定し、SSO認証をトリガーします。
logouturi	オプション。ログアウト・ページのURIを指定し、サインオン・ユーザーをログアウトします。指定しない場合、デフォルトのlogouturi=NONEに設定されます。 ""に設定して、ADFセキュリティがOPSSログアウト・サービスを呼び出すようにします。このサービスはクラスOAMSSOServiceImplの実装を使用して、Cookie ObSSOCookieをクリアします。 より一般的には、ユーザーをログアウトすることなくCookieをクリアする必要があるADFセキュアなWebアプリケーションでは、この設定を使用してください。
autologinuri	必須。自動ログイン・ページのURIを指定します。オプション。指定しない場合、この値はデフォルトのautologin=NONEに設定されます。
beginimpuri	オプション。偽装SSOセッションをトリガーするURIを指定します。
endimpuri	オプション。偽装SSOセッションを終了するURIを指定します。

4.7.7.3 例

次の呼出しは、渡されたURIを持つSSOプロバイダを追加します。上の表で説明するように、logouturi=""および偽装パラメータを設定することにより特殊な動作が暗示されます。

addOAMSSOProvider(loginuri="/${app.context}/adfAuthentication",
logouturi="/oamsso/logout.html",
beginimpuri="https://login.acme.com/impersonationInit.html"
endimpuri="https://login.acme.com/impersonationTerm.html")
autologin="/fooBar.cgi")

4.7.8 displayTopology

デプロイメント内のすべてのOAMサーバーに関する情報を表示するオンラインおよびオフライン・コマンド。

4.7.8.1 説明

デプロイ済のOAMサーバーのトポロジを一覧表示します。このコマンドには引数はありません。

4.7.8.2 構文

displayTopology

4.7.8.3 例

次の呼出しは、前述のようにすべてのデプロイ済OAMサーバーの詳細を一覧表示します。

displayTopology

4.7.9 displayMetrics

OAMサーバーおよびドメインのパフォーマンス・メトリックを表示するオンライン・コマンド。

4.7.9.1 説明

ホスト、プロセス、サーバー名など、コレクタに固有のOAMサーバーおよびドメインのパフォーマンス・メトリックを表示します。このコマンドには引数はありません。

引数が何も指定されない場合は、すべてのサーバーとコレクタのすべての詳細が表示されます。

4.7.9.2 構文

displayMetrics()

4.7.9.3 例

次の呼出しは、前述のように指定されたコレクタに固有のすべてのメトリックを一覧表示します。

displayMetrics()

4.7.10 displayOamServer

OAMサーバー登録の詳細を表示するオンラインおよびオフライン・コマンド。

4.7.10.1 説明

ホスト、ポート、登録名、OAMプロキシ・ポート、サーバーIDなどのOAMサーバー登録の詳細、およびオプションでOAMプロキシ共有シークレットを表示します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.10.2 構文

displayOamServer(host,port)

引数	定義
host	必須。OAMサーバー・ホストの名前を指定します。
port	必須。OAMサーバー・ホストのリスニング・ポートを指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.10.3 例

次の呼出しは、前述のように指定されたコレクタに固有のすべてのメトリックを一覧表示します。

displayOamServer(host="my_host", port="15000", domainHome="domainHome1")

4.7.11 createOamServer

システム構成内にOAMサーバー・エントリを作成するオンラインおよびオフライン・コマンド。

4.7.11.1 説明

ホスト、ポート、登録名、OAMプロキシ・ポート、サーバーIDなどのOAMサーバー登録、およびオプションでOAMプロキシ共有シークレットを作成します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.11.2 構文

createOamServer(host,port, paramNameValueList)

引数	定義
host	必須。OAMサーバー・ホストの名前を指定します。
port	必須。OAMサーバー・ホストのリスニング・ポートを指定します。
domainHome	オフライン・モード: 必須 オンライン・モード: オプション
paramNameValueList	パラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' 必須: configurationProfile: このインスタンス登録の名前で、OAM管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。 oamProxyPort: このインスタンスのリスニング・ポートです。 oamProxyServerID: このサーバー・インスタンスのOAMプロキシの名前で、OAM管理コンソールのサーバー・インスタンスのOAMプロキシ・サブ・タブの下に表示されます。 siteName: インスタンスのsiteName/serverNameです。

4.7.11.3 例

次の呼出しは、リスニング・ポート15000でyour_hostの構成を作成します。管理コンソール内の構成エントリはoam_server1になります。次のように、OAMプロキシ・ポートは3004、OAMプロキシ・サーバーIDはAccessServerConfigProxyです。

createOamServer(host="my_host", port="15000", configurationProfile=
"oam_server1", oamProxyPort="3004", oamProxyServerID="ProxyID", 
siteName="siteName1",domainHome="domainHome1")

4.7.12 editOamServer

OAMサーバー登録の詳細を編集できるようにするオンラインおよびオフライン・コマンド。

4.7.12.1 説明

ホスト、ポート、登録名、OAMプロキシ・ポート、サーバーIDなどのOAMサーバーの登録、およびオプションでOAMプロキシ共有シークレットを編集します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.12.2 構文

editOamServer(name, port, paramNameValueList)

引数	定義
name	必須。OAMサーバー・ホストの名前を指定します。
port	必須。OAMサーバー・ホストのポート番号を指定します。
domainHome	オフライン・モード: 必須 オンライン・モード: オプション
paramNameValueList	パラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' 必須: configurationProfile: このインスタンス登録の名前で、OAM管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。 oamProxyPort: このインスタンスのリスニング・ポートです。 oamProxyServerID: このサーバー・インスタンスのOAMプロキシの名前で、OAM管理コンソールのサーバー・インスタンスのOAMプロキシ・サブ・タブの下に表示されます。 siteName: インスタンスのsiteName/serverNameです。

4.7.12.3 例

任意のオプションの属性を使用して、現在の設定を変更できます。次の呼出しは、OAMプロキシ共有シークレットを構成エントリoam_server1に追加します。

editOamServer(name="oam_server1", port="15000",configurationProfile=
"oam_server1", oamProxyPort="3004",oamProxyServerID="Proxy1", 
siteName="siteName1",domainHome="domainHome1")

4.7.13 deleteOamServer

指定されたOAMサーバー登録を削除するオンラインおよびオフライン・コマンド。

4.7.13.1 説明

OAMサーバー構成全体を削除します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.13.2 構文

deleteOamServer(host,port)

引数	定義
host	必須。OAMサーバー・ホストの名前を指定します。
port	必須。OAMサーバー・ホストのリスニング・ポートを指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.13.3 例

次の呼出しは、リスニング・ポートが15000であるoam_server1OAMサーバーの登録を削除します。

deleteOamServer(host="oam_server1",port="15000",domainHome="domainHome1")

4.7.14 displayOssoAgent

OSSOエージェント構成の詳細を表示するオンラインおよびオフライン・コマンド。

4.7.14.1 説明

OSSOエージェント登録の詳細を表示します。これはOAM管理コンソールにも表示されます。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.14.2 構文

displayOssoAgent(agentName)

引数	定義
agentName	必須。OSSOエージェントの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.14.3 例

次の呼出しは、OSSOエージェントの登録情報を表示します。

displayOssoAgent(agentName="OSSOAgent1",domainHome="domainHome1")

4.7.15 editOssoAgent

OSSOエージェント登録を編集するオンラインおよびオフライン・コマンド。

4.7.15.1 説明

サイト・トークン、成功URL、失敗URL、ホームURL、ログアウトURL、開始日、終了日、管理者ID、管理者情報など、OSSOエージェントの構成の詳細を変更します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.15.2 構文

editOssoAgent(agentName,paramNameValueList)

引数	定義
agentName	必須。OSSOエージェントの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション
paramNameValueList	更新するパラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' オプション: siteToken: 認証の要求時にパートナが使用するアプリケーション・トークンです。 successUrl: 認証の成功時に使用するリダイレクトURLです。 failureUrl: 認証の失敗時に使用するリダイレクトURLです。 homeUrl: 認証後にホーム・ページで使用するリダイレクトURLです。 logoutUrl: ログアウト時に使用するリダイレクトURLです。サーバー上のグローバル・ログアウト・ページにユーザーをリダイレクトします。 startDate: アプリケーションへのログインがサーバーによって許可される最初の年月日です。 endDate: アプリケーションへのログインがサーバーによって許可される最後の年月日です。 adminId: このmod_ossoインスタンスの管理者ログインIDです。 adminInfo: このmod_ossoインスタンスの管理者詳細です。

4.7.15.3 例

次の呼出しは、OSSOAgent1の登録エントリ内の管理者IDおよび情報を変更します。

editOssoAgent(agentName="OSSOAgent1", siteToken="siteToken", 
successUrl="successUrl",failureUrl="failureUrl",homeUrl="homeUrl", 
logoutUrl="logoutUrl",startDate="2009-12-10", endDate="2012-12-30",  
adminId= 345", adminInfo="Agent11", domainHome="domainHome1") 

4.7.16 deleteOssoAgent

OSSOエージェント登録を削除するオンラインおよびオフライン・コマンド。

4.7.16.1 説明

OSSOエージェント構成を削除します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.16.2 構文

deleteOssoAgent(agentName)

引数	定義
agentName	必須。OSSOエージェントの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.16.3 例

次の呼出しは、OSSOAgent1という名前のOSSOエージェントを削除します。

deleteOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")

4.7.17 displayWebgateAgent

10g Webゲート登録を表示するオンラインおよびオフライン・コマンド。

4.7.17.1 説明

すべての10g Webゲート登録の詳細を表示します。これはOAM管理コンソールにも表示されます。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.17.2 構文

displayWebgateAgent(agentName)

引数	定義
agentName	必須。Webゲート・エージェントの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.17.3 例

次の呼出しは、my_WebGateの登録情報を表示します。

displayWebgateAgent(agentName=)"my_Webgate", domainHome="domainHome1")

4.7.18 editWebgateAgent

10g Webゲート登録を編集するオンラインおよびオフライン・コマンド。

4.7.18.1 説明

10g Webゲート・エージェント登録の詳細を変更できます。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.18.2 構文

editWebgateAgent(agentName,paramNameValueList)

引数	定義
agentName	必須。Webゲート・エージェントの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション
paramNameValueList	更新するパラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' 必須: agentId: OAMエージェント(Webゲート)の名前です。 オプション: accessClientPassword: このWebゲート・エージェントのオプションのパスワードです。 state: OAMエージェントが有効か無効かを示します。 preferredHost: ホスト識別子リストにホストの識別子が含まれていない場合に作成される可能性があるセキュリティ・ホールを防止します。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。 aaaTimeOutThreshold: OAMランタイム・サーバーからのレスポンスを待機する秒数です。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルトは-1です(デフォルトのネットワークTCP/IPタイムアウトが使用されます)。 security: OAMランタイム・サーバーとの間のトランスポート・セキュリティのレベル(オープン、簡易または証明書)です。 primaryCookieDomain: acompany.comなど、OAMエージェントがデプロイされているWebサーバー・ドメインです。 maxConnections: このOAMエージェントがOAMサーバーで確立できる接続の最大数です。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルトは1です。 maxCacheElements: キャッシュ内で維持される要素の数です。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルトは10000です。 cacheTimeOut: キャッシュされた情報が使用も参照もされない場合に、その情報がOAMエージェント・キャッシュ内にとどまる時間です。デフォルトは1800(秒)です。 cookieSessionTime: ObSSOCookieが保持される時間です。デフォルトは3600(秒)*です。 maxSessionTime: ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)です。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。デフォルトは3600(秒)です。値0を指定すると、このタイムアウト設定は無効になります。 idleSessionTimeout: OAMエージェントで保護されているリソースにアクセスすることなく、ユーザーの認証セッションが有効である時間(秒単位)です。デフォルトは3600(秒)です。値0を指定すると、このタイムアウト設定は無効になります。 failoverThreshold: このOAMエージェントがセカンダリOAMサーバーへの接続を開く時点を表す数です。デフォルトは1です。

4.7.18.3 例

任意の設定またはすべての設定を変更できます。次の呼出しを使用して、エージェントID、状態、最大接続数、OAMサーバーのタイムアウト、プライマリCookieドメイン、キャッシュ・タイムアウト、Cookieセッション・タイムアウト、最大セッション・タイムアウト、アイドル・セッション・タイムアウトおよびフェイルオーバーしきい値など、Webゲート・エージェント登録の特定の情報を次のように変更します。

editWebgateAgent(agentName="my_WebGate", agentId="WebGate2", state=
"enabled", maxConnections="2", aaaTimeOutThreshold="2", 
primaryCookieDomain="adomain.com", cacheTimeOut="1200", 
cookieSessionTime=1500, maxSessionTime=1500, idleSessionTimeout=
"1500", failoverThreshold="25", domainHome="domainHome1")

4.7.19 deleteWebgateAgent

10g Webゲート登録を削除するオンラインおよびオフライン・コマンド。

4.7.19.1 説明

10g Webゲート・エージェントの登録を削除します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.19.2 構文

deleteWebgateAgent(agentName)

引数	定義
agentName	必須。Webゲート・エージェントの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.19.3 例

次の呼出しは、my_WebGateという名前のWebゲート・エージェントを削除します。

deleteWebgateAgent(agentName="my_WebGate", domainHome="domainHome1")

4.7.20 changeLoggerSetting

ロガー・レベルを変更するオンラインおよびオフライン・コマンド。

4.7.20.1 説明

1つ以上、またはすべてのロガーのレベルを変更します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.20.2 構文

changeLoggerSetting (loggerName='', loggerLevel=''): 

引数	定義
loggerName	オプション。OAMロガー名を指定します。複数のOAMロガー名をカンマで区切って指定することも、ワイルドカード(*)を使用してすべてのOAMコレクタを指定する(デフォルト)ことも可能です。
loggerLevel	SEVERE、WARNING、INFO、CONFIG、FINE。

4.7.20.3 例

次の呼出しは、ロガー・レベルをSEVEREに変更します。

changeLoggerSetting(loggerName=" ", loggerLevel=SEVERE)

4.7.21 changeConfigDataEncryptionKey

構成データ暗号化鍵を再生成するオフライン・コマンド。

4.7.21.1 説明

構成データ暗号化鍵を再生成し、新しい鍵を使用して構成データを再暗号化して、アイデンティティ・ストアの属性情報を出力します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.21.2 構文

changePasswordEncKey (oldpassword='', newPassword='')

引数	定義
oldPassword	必須。現在の暗号化鍵を取得するパスワードを指定します。
newPassword	必須。新規生成された暗号化鍵を保護するパスワードを定義します。

4.7.21.3 例

次の呼出しは、新旧のパスワードを変更し、鍵を再生成して、構成データを再暗号化します。

changePasswordEncKey(oldpassword="oldpassword", 
newPassword="newpassword")

4.7.22 displayUserIdentityStore

ユーザー・アイデンティティ・ストアの登録に関する情報を表示するオンラインおよびオフライン・コマンド。

4.7.22.1 説明

Oracle Access Managerに登録されているユーザー・アイデンティティ・ストアの情報を表示します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.22.2 構文

displayUserIdentityStore(name) 

引数	定義
name	必須。LDAPユーザー・アイデンティティ・ストアの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.22.3 例

次の呼出しは、ユーザー・アイデンティティ・ストアの登録の詳細を表示します。

displayUserIdentityStore(name="ID_store1", domainHome="domainHome1")

4.7.23 editUserIdentityStore

Oracle Access Managerのユーザー・アイデンティティ・ストアの属性を変更するオンラインおよびオフライン・コマンド。

4.7.23.1 説明

Oracle Access Managerに登録されているユーザー・アイデンティティ・ストアの属性を1つ以上変更します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.23.2 構文

editUserIdentityStore(name,paramNameValueList)

引数	定義
name	必須。LDAPユーザー・アイデンティティ・ストアの一意の名前を指定します(大文字と小文字のアルファベットおよび数字のみ)。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション
paramNameValueList	パラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' createUserIdentityStoreにあるものに加えて、次の1つ以上のパラメータの名前-値ペアを追加して、OAMユーザー・アイデンティティ・ストア構成を変更します。 userFilterObjectClasses: ユーザー・フィルタ・オブジェクト・クラスのリスト(セミコロンで区切られたもの)です。 groupFilterObjectClasses: グループ・フィルタ・オブジェクト・クラスのリスト(セミコロンで区切られたもの)です。 referralPolicy: LDAP参照ポリシー(follow、ignore、throwのいずれか)です。 searchTimeLimit: LDAP検索操作の時間制限(秒単位)です。 minConnections: 接続プールの接続の最小数です。 maxConnections: 接続プールの接続の最大数です。 connectionWaitTimeout: プールから接続を取得するために待機する秒数です。 connectionRetryCount: アイデンティティ・ストアへの接続の確立を試行する回数です。 groupNameAttr: ユーザー・グループを検索するための属性の名前です。例: ou=people,ou=myrealm,dc=base_domain groupCacheEnabled: LDAPグループ・キャッシュを有効化するトグル(true/false)です。 groupCacheSize: LDAPグループ・キャッシュ内のエントリの数です。 groupCacheTTL: LDAPグループ・キャッシュ内の各エントリの合計存続時間です。

4.7.23.3 例

次の呼出しは、OAMのユーザー・アイデンティティ・ストアのLDAP URLを変更します。

editUserIdentityStore(name="identity_store_name", 
LDAP_url="ldap://localhost:7003", domainHome="domaonHome1")

4.7.24 createUserIdentityStore

Oracle Access Manager用のユーザー・アイデンティティ・ストアの登録を作成するオンラインおよびオフライン・コマンド。

4.7.24.1 説明

Oracle Access Managerに登録する新しいユーザー・アイデンティティ・ストアのエントリを作成します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.24.2 構文

createUserIdentityStore(name=,paramNameValueList)

引数	定義
name	必須。LDAPユーザー・アイデンティティ・ストアの一意の名前を指定します(大文字と小文字のアルファベットおよび数字のみ)。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション
paramNameValueList	パラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' 必須: name: このユーザーIDストアの名前です。 principal: LDAP管理者のログインIDです。たとえば、cn=Adminです。 credential: プリンシパルのパスワードで、セキュリティ用に暗号化されています。 type: 作成されるLDAP IDストアのタイプです。 userAttr: ストアのユーザー属性です。 usersearchbase: 作成するLDAP IDストア内の、ユーザー・データが格納されるノードです。たとえば、cn=usersです。 groupSearchBase: 作成するLDAP IDストア内の、グループ・データが格納されるノードです。必須の属性です。たとえば、cn=groupsです。 ldapUrl: 作成するLDAP IDストアのLDAPホストのURL(ポート番号を含む)です。たとえば、ldap://localhost:7001です。 オプション: roleSecAdmin: LDAP IDストアのすべての権限を持つ管理グループの名前です。 roleSysMonitor: 作成するLDAP IDストアの読取り専用権限を持つ管理グループの名前です。 roleSysManager: 作成するLDAP IDストアの日常的な操作権限を持つ管理グループの名前です。 ldapProvider: サポートされているLDAPプロバイダです。たとえば、OVDです。 isPrimary: プライマリ・ユーザー・アイデンティティ・ストアの指定です。ブール・フィールドです。 userIDProvider: 作成するストアのユーザー・アイデンティティ・プロバイダです。 domainHome: ドメイン・ホームの場所です。

4.7.24.3 例

次の呼出しは、Oracle Access Managerで使用するための新しいOracle Internet Directoryユーザー・アイデンティティ・ストア定義を作成します。

createUserIdentityStore(name="Name1",principal="Principal1", 
credential="Credential1", type="OID", userAttr="userAttr1", 
ldapProvider="ldapProvider", roleSecAdmin="roleSecAdmin1",
roleSysMonitor="roleSysMonitor", roleSysManager="roleSysManager", 
roleAppAdmin="roleAppAdmin", userSearchBase="cn=users, 
ldapUrl="ldapUrl", isPrimary="isPrimary", userIDProvider="userIDProvider",
groupSearchBase="cn=groups",domainHome="domainHome1")

4.7.25 deleteUserIdentityStore

Oracle Access Managerユーザー・アイデンティティ・ストアの登録を削除するオンラインおよびオフライン・コマンド。

4.7.25.1 説明

Oracle Access Managerに登録されているユーザー・アイデンティティ・ストアを削除します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.25.2 構文

deleteUserIdentityStore(name) 

引数	定義
name	必須。削除するLDAPユーザー・アイデンティティ・ストアの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.25.3 例

次の呼出しは、ユーザー・アイデンティティ・ストアの登録を削除します。

deleteUserIdentityStore(name="identity_store", domainHome="domainHome1")

4.7.26 configRequestCacheType

SSOサーバー・リクエスト・キャッシュ・タイプを構成するオンラインおよびオフライン・コマンド。

4.7.26.1 説明

SSOサーバー・リクエスト・キャッシュ・タイプを構成します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.26.2 構文

configRequestCacheType(type) 

引数	定義
type	必須。requestCacheTypeを指定します。 requestCacheType: リクエスト・キャッシュ・タイプの値(BASICまたはCOOKIE)です。

4.7.26.3 例

次の呼出しは、リクエスト・キャッシュ・タイプをCookieとして定義します。

configRequestCacheType(type="COOKIE") 

4.7.27 displayRequestCacheType

SSOサーバー・リクエスト・キャッシュ・タイプを表示するオンラインおよびオフライン・コマンド。

4.7.27.1 説明

SSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.27.2 構文

displayRequestCacheType(domainHome)

引数	定義
type	必須。requestCacheTypeを指定します。 requestCacheType: リクエスト・キャッシュ・タイプの値(BASICまたはCOOKIE)です。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.27.3 例

次の呼出しは、リクエスト・キャッシュ・タイプを表示します。

displayRequestCacheType(domainHome="domainHome") 

4.7.28 exportPolicy

テスト(ソース)環境から指定された中間Oracle Access ManagerファイルにOAMポリシー・データをエクスポートするオンラインのみのコマンド。

4.7.28.1 説明

テスト(ソース)環境から中間Oracle Access ManagerファイルにOAMポリシー・データをエクスポートします。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.28.2 構文

exportPolicy(pathTempOAMPolicyFile)

引数	定義
pathTempOAMPolicyFile	必須。一時Oracle Access Managerファイルへのパスを指定します。

4.7.28.3 例

次の呼出しは、ポリシー・データをテスト(ソース)環境からエクスポートする際に使用する一時ファイルへのパスを指定します。

exportPolicy(pathTempOAMPolicyFile="oam_policy.xml") 

4.7.29 importPolicy

指定された中間Oracle Access ManagerファイルからOAMポリシー・データをインポートするオンラインのみのコマンド。

4.7.29.1 説明

指定された中間Oracle Access ManagerファイルからOAMポリシー・データをインポートします。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.29.2 構文

importPolicy(pathTempOAMPolicyFile)

引数	定義
pathTempOAMPolicyFile	必須。一時OAMファイルへのパスを指定します。

4.7.29.3 例

次の呼出しは、ポリシー・データを本番(ターゲット)にインポートする際に使用する一時ファイルへのパスを指定します。

importPolicy(pathTempOAMPolicyFile="oam_policy.xml") 

4.7.30 importPolicyDelta

指定された中間Oracle Access ManagerファイルからOAMポリシー変更をインポートするオンラインのみのコマンド。

4.7.30.1 説明

指定された中間Oracle Access ManagerファイルからOAMポリシー変更をインポートします。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.30.2 構文

importPolicyDelta(pathTempOAMPolicyFile)

引数	定義
pathTempOAMPolicyFile	必須。一時Oracle Access Managerファイルへのパスを指定します。

4.7.30.3 例

次の呼出しは、変更されたポリシー・データのみを本番(ターゲット)にインポートする際に使用する一時ファイルへのパスを指定します。

importPolicyDelta(pathTempOAMPolicyFile="oam_policy_delta.xml") 

4.7.31 migratePartnersToProd

現在の(ソース)OAMサーバーから指定された(ターゲット)OAMサーバーにパートナを移行するオンラインのみのコマンド。

4.7.31.1 説明

現在の(ソース)OAMサーバーから指定された(ターゲット)OAMサーバーにパートナを移行します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.31.2 構文

migratePartnersToProd(prodServerHost,prodServerPort,prodServerAdminUser,prodServerAdminPwd)

引数	定義
prodServerHost	パートナの移行先となるターゲットOAMサーバーのホスト名。
prodServerPort	パートナの移行先となるターゲットOAMサーバーのポート。
prodServerAdminUser	パートナの移行先となるターゲットOAMサーバーの管理者。
prodServerAdminPwd	ターゲットOAMサーバーの管理者のパスワード。

4.7.31.3 例

次の呼出しは、必要な情報を指定します。

migratePartnersToProd(prodServerHost="host",prodServerPort="port", 
prodServerAdminUser="weblogic",prodServerAdminPwd="welcome")

4.7.32 exportPartners

Oracle Access Managerパートナを、ソースから指定された中間Oracle Access Managerファイルにエクスポートするオンラインのみのコマンド。

4.7.32.1 説明

Oracle Access Managerパートナを、ソースから指定された中間Oracle Access Managerファイルにエクスポートします。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.32.2 構文

exportPartners(pathTempOAMPartnerFile)

引数	定義
pathTempOAMPartnerFile	必須。一時Oracle Access Managerパートナ・ファイルへのパスを指定します。

4.7.32.3 例

次の呼出しは、中間OAMパートナ・ファイルへのパスを指定します。

exportPartners(pathTempOAMPartnerFile="oam_partners.xml")

4.7.33 importPartners

指定された中間Oracle Access ManagerファイルからOracle Access Managerパートナをインポートするオンラインのみのコマンド。

4.7.33.1 説明

指定された中間Oracle Access ManagerファイルからOAMパートナをインポートします。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.33.2 構文

importPartners(pathTempOAMPartnerFile)

引数	定義
pathTempOAMPartnerFile	必須。一時OAMパートナ・ファイルへのパスを指定します。

4.7.33.3 例

次の呼出しは、中間OAMパートナ・ファイルへのパスを指定します。

importPartners(pathTempOAMPartnerFile="oam_partners.xml")

4.7.34 configureOAAM

Oracle Access ManagerとOracle Adaptive Access Managerの基本的な統合を構成するオンラインのみのコマンド。

4.7.34.1 説明

OAMとOAAMの基本的な統合を構成します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.34.2 構文

configureOAAM(dataSourceName,paramNameValueList)

引数	定義
dataSourceName	作成するデータソースの名前です。
paramNameValueList	パラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' 必須: hostName: データベース・ホストの名前です。 port: データベース・ポートです。 sid: データベースSID(データベース識別子)です。 userName: OAAMスキーマ名です。 passWord: OAAMスキーマ・パスワードです。 オプション: maxConnectionSize: 最大接続維持時間サイズです。 maxPoolSize: 接続プールの最大サイズです。 serverName: データソースのターゲット・サーバーです。

4.7.34.3 例

次の呼出しは、Oracle Access ManagerとOracle Adaptive Access Managerの基本的な統合を構成します。

configureOAAM(dataSourceName = "MyOAAMDS", hostName = "host.us.co.com", 
port = "1521", sid = "sid", userName = "username", passWord = "password", 
maxConnectionSize = None, maxPoolSize = None, serverName = "oam_server1")

4.7.35 registerOIFDAPPartner

Oracle Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録するオンラインおよびオフライン・コマンド。

4.7.35.1 説明

Oracle Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.35.2 構文

registerOIFDAPPartner()

引数	定義
paramNameValueList	パラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' 必須: 新規のOAMユーザー・アイデンティティ・ストア構成を作成する、次のパラメータの名前-値ペアが含まれます。 keystoreLocation: キーストア・ファイル(OIFサーバーで生成されたもの)の場所です。 logoutURL: OIFサーバーのログアウトURLです。 オプション: rolloverInterval: SASSOトークンの暗号化/復号化に使用するキーのロールオーバー間隔です。

4.7.35.3 例

次の呼出しは、すべてのパラメータの使用を示しています。

registerOIFDAPPartner(keystoreLocation="/scratch/keystore", 
logoutURL="http://<oifhost>:<oifport>/fed/user/sploosso?doneURL=http://<oamhost>: 
<oam port>/ngam/server/pages/logout.jsp", rolloverTime="526")

4.7.36 enableCoexistMode

共存モードを有効にするオンライン・コマンド。

4.7.36.1 説明

共存モードを有効にします。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.36.2 構文

enableCoexistMode()

4.7.36.3 例

次の呼出しは、共存モードを有効にします。

enableCoexistMode

4.7.37 disableCoexistMode

共存モードを無効にするオンライン・コマンド。

4.7.37.1 説明

共存モードを無効にします。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.37.2 構文

disableCoexistMode()

4.7.37.3 例

次の呼出しは、共存モードを有効にします。

disableCoexistMode

4.7.38 editGITOValues

GITO構成パラメータを編集するオンラインおよびオフライン・コマンド。

4.7.38.1 説明

GITO構成パラメータを編集します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.38.2 構文

editGITOValues(gitoEnabled, paramNameValueList)

引数	定義
gitoEnabled	true(またはfalse)。ユーザーによるGITO対応プロパティの設定を許可(または拒否)します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション
paramNameValueList	パラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' 必須: 新規のOAMユーザー・アイデンティティ・ストア構成を作成する、次のパラメータの名前-値ペアが含まれます。 gitoCookieDomain: GITO Cookieドメイン・エントリを設定します。 オプション: gitoCookieName: GITO Cookie名を設定します。 gitoVersion: GITOバージョンを設定します。v1.0またはv3.0のいずれかのみ可能です。 gitoTimeout: GITOタイムアウト値を設定します。 gitoSecureCookieEnabled: true(またはfalse)。ユーザーによるGITO Cookie対応プロパティの設定を許可(または拒否)します。

4.7.38.3 例

次の呼出しは、GITO構成パラメータを編集します。

editGITOValues(gitoEnabled="true",gitoCookieDomain=".abc.com",gitoCookieName="ABC"
,gitoVersion="v1.0",gitoTimeout="20",gitoSecureCookieEnabled="false",domainHome="/
abc/def/ijk")\n

4.7.39 editWebgate11gAgent

11g Webゲート登録を編集するオンラインおよびオフライン・コマンド。

4.7.39.1 説明

11g Webゲートの登録を編集します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.39.2 構文

editWebgate11gAgent(agentname, paramNameValueList)

引数	定義
agentname	編集する登録済OAM 11g Webゲート・エージェントの名前です。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション
paramNameValueList	パラメータの名前-値ペアのカンマ区切りリストを指定します。各ペアの形式は次のとおりです。 paramName='paramValue' オプション: accessClientPassword: このWebゲートの一意のパスワードです。 state: エージェントが有効か無効かを指定します。 security: エージェントとOAMサーバー間の通信セキュリティのレベル(オープン、簡易、証明書)です。 aaaTimeOutThreshold: OAMサーバーからのレスポンスを待機する秒数です。 logOutUrls: ログアウト・ハンドラをトリガーするURLのリスト。ログアウト・ハンドラは、ObSSOCookieを削除します。 maxConnections: このOAMエージェントがOAMサーバーで確立できる接続の最大数です。 maxCacheElements: キャッシュ内で維持される要素の数です。 cacheTimeout: キャッシュされた情報が使用も参照もされない場合に、その情報がOAMエージェント・キャッシュ内にとどまる時間です。デフォルトは1800(秒)です。 logoutCallbackUrl: oam_logout_successへのURL。oam_logout_successは、コールバック中にCookieを消去します。デフォルトでは、これは、エージェントの登録時に指定されたエージェント・ベースURLに基づきます。例: http://<host>:<port> maxSessionTime: ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)です。 logoutRedirectUrl: 中央ログアウト・ページ(logout.html)へのURL(絶対パス)です。デフォルトでは、これは、デフォルト・ポート14200のOAM管理コンソールのホスト名に基づきます。 failoverThreshold: このOAMエージェントがセカンダリOAMサーバーへの接続を開く時点を表す数です。 tokenValidityPeriod: OAMエージェントで保護されているリソースにアクセスすることなく、ユーザーの認証セッションが有効である時間(秒単位)です。 logoutTargetUrlParamName: ログアウト時にOPSSアプリケーションからWebゲートに渡される問合せパラメータの名前です。

4.7.39.3 例

次の呼出しは、必須のパラメータとオプションのパラメータをすべて一覧表示します。

editWebgate11gAgent(agentName="WebgateAgent1", accessClientPasswd = "welcome1", 
state = "Enabled", preferredHost="141.144.168.148:2001", aaaTimeoutThreshold="10",
security = "open", logOutUrls = "http://<host>:<port>", maxConnections = "16" 
maxCacheElems = "10000" , cacheTimeout = "1800", logoutCallbackUrl = 
"http://<host>:<port>", maxSessionTime = "24", logoutRedirectUrl =  
"logoutRedirectUrl", failoverThreshold = "1", tokenValidityPeriod="aPeriod" 
logoutTargetUrlParamName = "logoutTargetUrl", domainHome="domainHome1")

4.7.40 deleteWebgate11gAgent

11g Webゲート登録を削除するオンラインおよびオフライン・コマンド。

4.7.40.1 説明

11g Webゲート・エージェントの登録を削除します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.40.2 構文

deleteWebgate11gAgent(agentName)

引数	定義
agentName	必須。11g Webゲート・エージェントの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.40.3 例

次の呼出しは、my_11gWebGateという名前の11g Webゲート・エージェントのエントリを削除します。

deleteWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")

4.7.41 displayWebgate11gAgent

11g Webゲート・エージェントの登録を表示するオンラインおよびオフライン・コマンド。

4.7.41.1 説明

11g Webゲート・エージェントの登録を表示します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.41.2 構文

displayWebgate11gAgent(agentName)

引数	定義
agentName	必須。Webゲート・エージェントの名前を指定します。
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.41.3 例

次の呼出しは、my_11gWebGateという名前のWebゲート・エージェントを表示します。

displayWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")

4.7.42 displayOAMMetrics

OAMサーバーのメトリックを表示するオンラインおよびオフライン・コマンド。

4.7.42.1 説明

OAMサーバーのメトリックを表示します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.42.2 構文

displayOAMMetrics(domainHome)

引数	定義
domainhome	オフライン・モード: 必須 オンライン・モード: オプション

4.7.42.3 例

次の呼出しは、OAMサーバーのメトリックを表示します。

displayOAMMetrics (domainHome=(domainHome1") 

4.7.43 updateOIMHostPort

Oracle Access Managerとの統合時にOracle Identity Manager構成を更新するオンラインのみのコマンド。

4.7.43.1 説明

システム構成内のOracle Identity Manager構成を更新します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.43.2 構文

updateOIMHostPort(hostname, port, secureProtocol)

引数	定義
hostname	Oracle Identity Managerホストの名前。
port	Oracle Identity Managerホストのポート。
secureProtocol	trueまたはfalse。

4.7.43.3 例

次の呼出しは、このコマンドの使用例を示します。

updateOIMHostPort(hostName="OIM host", port="7777", secureProtocol="true") 

4.7.44 configureOIM

Oracle Access Managerとの統合時にOracle Identity Manager固有のエージェントの登録を作成するオンラインのみのコマンド。

4.7.44.1 説明

Oracle Access Managerとの統合時にOracle Identity Manager固有のエージェントの登録を作成します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.44.2 構文

updateOIMHostPort(hostname, port, secureProtocol)

引数	定義
hostname	Oracle Identity Managerホストの名前。
port	Oracle Identity Manager管理対象サーバーのポート。
oimSecureProtocolEnabled	trueまたはfalse (HTTPまたはHTTPSのどちらであるかに応じて)。
oimAccessGatePwd	指定する場合は、オープン・モードのエージェント・パスワードになります
oimCookieDomain	Cookieが設定されるドメイン
oimWgId	エージェントの登録名。
oimWgVersion	可能な値は10gまたは11g。指定しない場合、デフォルトは10gです。

4.7.44.3 例

次の呼出しは、このコマンドの使用例を示します。

updateOIMHostPort(hostName="OIM host", port="7777", secureProtocol="true") 
configureOIM(oimHost="OIM host", oimPort="7777", oimSecureProtocolEnabled="true",
oimAccessGatePwd = "Access Gate Password", oimCookieDomain = "OIM Cookie Domain",
oimWgId="OIM Webgate ID", oimWgVersion="OIM Webgate Version")

4.7.45 updateOSSOResponseCookieConfig

OSSOプロキシ・レスポンスCookie設定を更新するオンラインおよびオフライン・コマンド。

4.7.45.1 説明

OSSOプロキシ・レスポンスCookie設定を更新します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.45.2 構文

updateOSSOResponseCookieConfig()

引数	定義
domainhome	オフライン・モード: 必須 オンライン・モード: オプション
cookieName	オプション。設定が更新されるCookieの名前。指定しない場合、グローバル設定が更新されます。
cookieMaxAge	Cookieの最大保持時間(分単位)。負の値の場合、セッションCookieが設定されます。
isSecureCookie	Cookieを保護する(SSLチャネルのみで送信する)かどうかを指定するブール・フラグ。
cookieDomain	Cookieのドメイン。

4.7.45.3 例

次の呼出しは、このコマンドの使用例を示します。

updateOSSOResponseCookieConfig(cookieName = "<cookieName>",
cookieMaxAge = "<cookie age in minutes>", isSecureCookie = "true | false",
cookieDomain="<domain of the cookie>", domainHome = "<wls_domain_home_path>")

4.7.46 deleteOSSOResponseCookieConfig

OSSOプロキシ・レスポンスCookie設定を削除するオンラインおよびオフライン・コマンド。

4.7.46.1 説明

OSSOプロキシ・レスポンスCookie設定を削除します。

このコマンドのスコープはインスタンスのみです。スコープは引数ではありません。

4.7.46.2 構文

deleteOSSOResponseCookieConfig()

引数	定義
domainhome	オフライン・モード: 必須 オンライン・モード: オプション
cookieName	必須。設定が削除されるCookieの名前。

4.7.46.3 例

次の呼出しは、このコマンドの使用例を示します。

deleteOSSOResponseCookieConfig(cookieName = "<cookieName>",
cookieDomain="<domain of the cookie>", domainHome = "<wls_domain_home_path>")

4.7.47 displaySimpleModeGlobalPassphrase

システム構成から簡易モードのグローバル・パスフレーズを平文で表示します。

4.7.47.1 説明

システム構成から簡易モードのグローバル・パスフレーズを平文で表示するオンラインのみのコマンド。

4.7.47.2 構文

displaySimpleModeGlobalPassphrase

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

4.7.47.3 例

次の呼出しは、このコマンドの使用例を示します。

displaySimpleModeGlobalPassphrase

4.7.48 exportSelectedPartners

選択されたOAMパートナをエクスポートします。

4.7.48.1 説明

指定された中間OAMファイルに、選択されたOAMパートナをエクスポートします。

4.7.48.2 構文

exportSelectedPartners

引数	定義
pathTempOAMPartnerFile	移行されるパートナが含まれる一時ファイル
partnersNameList	移行されるパートナIDのカンマ区切りリスト

4.7.48.3 例

次の呼出しは、このコマンドの使用例を示します。

exportSelectedPartners (pathTempOAMPartnerFile="/exampleroot/parent/tempfile.extn"
partnersNameList="partner1,partner2"

4.7.49 migrateArtifacts

アーティファクトを移行します。

4.7.49.1 説明

入力アーティファクト・ファイルに基づいてアーティファクトを移行します。

4.7.49.2 構文

migrateArtifacts

引数	定義
path	アーティファクト・ファイルの場所が存在します
password	元のアーティファクトの生成時に使用されたパスワード。
type	InPlaceまたはOutOfPlace
isIncremental	trueまたはfalse。trueの場合、増分アップグレードが実行されます。

4.7.49.3 例

次の呼出しは、このコマンドの使用例を示します。

migrateArtifacts(path = "/exampleroot/parent/t", password = "password", type = 
"InPlace", isIncremental="false")

4.7.50 registerThirdPartyTAPPartner

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

4.7.50.1 説明

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

4.7.50.2 構文

registerThirdPartyTAPPartner

引数	定義
path	アーティファクト・ファイルの場所が存在します
password	元のアーティファクトの生成時に使用されたパスワード。
partnerName	パートナの名前。サード・パーティのパートナの識別に使用する任意の名前を指定できます。
keystoreLocation	jceksファイルの場所。
password	password
tapTokenVersion	Trusted Authentication Protocolのバージョン。
tapScheme	Trusted Authentication Protocol認証スキーム(TAPScheme、即時利用可能。)
tapRedirectUrl	サード・パーティ・アクセスURL。

4.7.50.3 例

registerThirdPartyTAPPartner (partnerName="ThirdPartyTAPPartner",keystoreLocation=
"/scratch/DAPKeyStore/mykeystore.jks",password="test",tapTokenVersion="v2.0",
tapScheme="TAPScheme",tapRedirectUrl="http://thirdpartyserverhost:port/
loginPage.jsp");

4.8 Oracle Security Token Service

表4-7では、Oracle Security Token Serviceで使用可能な、様々なタイプのWLSTコマンドについて説明します。

表4-7 WLSTのOracle Security Token Serviceコマンド・グループ

OSTSコマンド・タイプ	説明
パートナ・コマンド	パートナに関するタスクに関連するWLSTコマンド。
リライイング・パーティ・パートナ・マッピング・コマンド	リライイング・パーティ・パートナ・マッピングに対するWS接頭辞は、WS-Trust RSTリクエストのAppliesToフィールドで指定されているサービスURLをリライイング・パーティ・タイプのパートナにマップするために使用されます。WS接頭辞文字列として、サービスURLそのもの、またはサービスURLへの親パスを持つURLを指定できます。たとえば、マッピングで、WS接頭辞(http://test.com/service)をリライイング・パーティ(RelyingPartyPartnerTest)にマップすると定義されている場合、次のサービスURLがそのリライイング・パーティにマップされます。http://test.com/service、http://test.com/service/calculatorService、http://test.com/service/shop/cart...
パートナ・プロファイル・コマンド	パートナ・プロファイルに関するタスクに関連するWLSTコマンド。
発行テンプレート・コマンド	発行テンプレートに関するタスクに関連するWLSTコマンド。
検証テンプレート・コマンド	検証テンプレートに関するタスクに関連するWLSTコマンド。

表4-8に示されているWLSTコマンドを使用して、Oracle Security Token Serviceを管理します。

表4-8 WLSTコマンドのOracle Security Token Service

このコマンドを使用します...	次を行うには...	WLSTの使用...
パートナ・コマンド
getPartner	パートナおよび出力結果を取得します。	オンライン
getAllRequesterPartners	リクエスタ・パートナの名前を取得します。	オンライン
getAllRelyingPartyPartners	すべてのリライイング・パーティ・パートナの名前を取得します。	オンライン
getAllIssuingAuthorityPartners	すべての発行局パートナの名前を取得します。	オンライン
isPartnerPresent	OSTSを問い合せて、パートナがパートナ・ストア内に存在しているかどうかを判断します。	オンライン
createPartner	新しいパートナ・エントリを作成します。	オンライン
updatePartner	提供された情報に基づいて既存のパートナ・エントリを更新します。	オンライン
deletePartner	パートナ・エントリを削除します。	オンライン
getPartnerUsernameTokenUsername	パートナのユーザー名値を取得します。	オンライン
getPartnerUsernameTokenPassword	パートナのパスワード値を取得します。	オンライン
setPartnerUsernameTokenCredential	パートナ・エントリのユーザー名およびパスワード値を設定します。	オンライン
deletePartnerUsernameTokenCredential	パートナ・エントリからユーザー名およびパスワード値を削除します。	オンライン
getPartnerSigningCert	パートナのBase64エンコード署名証明書を取得します。	オンライン
getPartnerEncryptionCert	パートナのBase64エンコード暗号化証明書を取得します。	オンライン
setPartnerSigningCert	パートナ・エントリに署名証明書をアップロードします。	オンライン
setPartnerEncryptionCert	パートナ・エントリに暗号化証明書をアップロードします。	オンライン
deletePartnerSigningCert	パートナ・エントリから署名証明書を削除します。	オンライン オフライン
deletePartnerEncryptionCert	パートナ・エントリから暗号化証明書を削除します。	オンライン オフライン
getPartnerAllIdentityAttributes	トークンをリクエスタ・パートナにマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。	オンライン オフライン
getPartnerIdentityAttribute	アイデンティティ・マッピング属性を取得して表示します。	オンライン オフライン
setPartnerIdentityAttribute	リクエスタ・パートナのアイデンティティ・マッピング属性を設定します。	オンライン オフライン
deletePartnerIdentityAttribute	リクエスタ・パートナのアイデンティティ・マッピング属性を削除します。	オンライン オフライン
リライイング・パーティ・パートナ・マッピング・コマンド
getAllWSPrefixAndPartnerMappings	すべてのWS接頭辞を取得して表示します。	オンライン オフライン
getWSPrefixAndPartnerMapping	指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します。	オンライン オフライン
createWSPrefixAndPartnerMapping	リライイング・パートナへの新しいWS接頭辞マッピングを作成します。	オンライン オフライン
deleteWSPrefixAndPartnerMapping	リライイング・パートナへの既存のWS接頭辞マッピングを削除します。	オンライン オフライン
パートナ・プロファイル・コマンド
getAllPartnerProfiles	既存のすべてのパートナ・プロファイルの名前を取得します。	オンライン
getPartnerProfile	パートナ・プロファイル構成データを取得します。	オンライン
createRequesterPartnerProfile	デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成します。	オンライン
createRelyingPartyPartnerProfile	デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成します。	オンライン
createIssuingAuthorityPartnerProfile	デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成します。	オンライン
deletePartnerProfile	既存のパートナ・プロファイルを削除します。	オンライン
発行テンプレート・コマンド
getAllIssuanceTemplates	既存のすべての発行テンプレートの名前を取得します。	オンライン オフライン
getIssuanceTemplate	特定の発行テンプレートの構成データを取得します。	オンライン
createIssuanceTemplate	デフォルトの構成データを使用して新しい発行テンプレートを作成します。	オンライン
deleteIssuanceTemplate	既存の発行テンプレートを削除します。	オンライン オフライン
検証テンプレート・コマンド
getAllValidationTemplates	既存のすべての検証テンプレートの名前を取得します。	オンライン オフライン
getValidationTemplate	特定の検証テンプレートの構成データを取得します。	オンライン オフライン
createWSSValidationTemplate	デフォルトの構成データを使用して新しいWS-Security検証テンプレートを作成します。	オンライン オフライン
createWSTrustValidationTemplate	デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成します。	オンライン オフライン
deleteValidationTemplate	既存の発行テンプレートを削除します。	オンライン オフライン

4.8.1 getPartner

パートナ・エントリを取得し、そのパートナの構成を出力するオンライン・コマンド。

4.8.1.1 説明

パートナ・エントリを取得し、そのパートナの構成を出力します。

4.8.1.2 構文

getPartner(partnerId)

引数	定義
partnerId	partnerId(パートナのID)を指定します。

4.8.1.3 例

次の呼出しは、パートナ・エントリを取得し、customPartnerの構成を出力します。

getPartner(partnerId="customPartner")

4.8.2 getAllRequesterPartners

リクエスタ・タイプのパートナを取得するオンライン・コマンド。

4.8.2.1 説明

リクエスタ・タイプのパートナを取得します。

4.8.2.2 構文

getAllRequesterPartners()

4.8.2.3 例

次の呼出しは、リクエスタ・タイプのパートナを取得します。

getAllRequesterPartners()

4.8.3 getAllRelyingPartyPartners

リライイング・パーティ・パートナを取得するオンライン・コマンド。

4.8.3.1 説明

リライイング・パーティ・パートナを取得します。

4.8.3.2 構文

getAllRelyingPartyPartners()

4.8.3.3 例

次の呼出しは、リライイング・パーティ・パートナを取得します。

getAllRelyingPartyPartners()

4.8.4 getAllIssuingAuthorityPartners

発行局パートナを取得し、結果を出力するオンライン・コマンド。

4.8.4.1 説明

発行局パートナを取得し、結果を出力します。

4.8.4.2 構文

getAllIssuingAuthorityPartners()

4.8.4.3 例

次の呼出しは、発行局パートナを取得し、その結果を出力します。

getAllIssuingAuthorityPartners()

4.8.5 isPartnerPresent

OSTSを問い合せて、指定されたパートナがパートナ・ストア内に存在しているかどうかを判断するオンライン・コマンド。

4.8.5.1 説明

OSTSを問い合せて、指定されたパートナがパートナ・ストア内に存在しているかどうかを判断し、結果を出力します。

4.8.5.2 構文

isPartnerPresent(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

4.8.5.3 例

次の呼出しは、OSTSを問い合せて、customPartnerがパートナ・ストア内に存在しているかどうかを判断し、結果を出力します。

isPartnerPresent(partnerId="customPartner")

4.8.6 createPartner

新しいパートナ・エントリを作成するオンライン・コマンド。

4.8.6.1 説明

提供された情報に基づいて新しいパートナ・エントリを作成します。操作の結果を示すメッセージを表示します。

4.8.6.2 構文

createPartner(partnerId, partnerType, partnerProfileId, description,
bIsTrusted)

引数	定義
partnerId	作成する新しいパートナのIDを指定します。
partnerType	パートナのタイプを指定します。値として、次のいずれかを指定できます。 リクエスタの場合は、STS_REQUESTER リライイング・パーティの場合は、STS_RELYING_PARTY 発行局の場合は、STS_ISSUING_AUTHORITY
partnerProfileId	このパートナに付加するプロファイルIDを指定します。これは、既存のパートナ・プロファイルを参照する必要があります。そのパートナ・プロファイルのタイプは、新しいパートナ・エントリのタイプに従う必要があります。
description	この新しいパートナ・エントリの説明(オプション)を指定します。
bIsTrusted	この新しいパートナを信頼するかどうかを示す値。値は次のいずれかです。 信頼する場合は、true 信頼しない場合は、false

4.8.6.3 例

次の呼出しは、STS_Requestorパートナ(customPartner, custom-partnerprofile、説明はcustom requester、信頼の値はtrue)を作成し、操作の結果を示すメッセージを表示します。

createPartner(partnerId="customPartner", partnerType="STS_REQUESTER",
partnerProfileId="custom-partnerprofile", description="custom requester",
bIsTrusted="true")

4.8.7 updatePartner

既存のパートナ・エントリを更新するオンライン・コマンド。

4.8.7.1 説明

提供された情報に基づいて既存のパートナ・エントリを更新します。操作の結果を示すメッセージを表示します。

4.8.7.2 構文

updatePartner(partnerId, partnerProfileId, description, bIsTrusted)

引数	定義
partnerId	更新する新しいパートナのIDを指定します。
partnerProfileId	パートナ・プロファイルIDを指定します。これは、既存のパートナ・プロファイルを参照する必要があります。そのパートナ・プロファイルのタイプは、新しいパートナ・エントリのタイプに従う必要があります。
description	この新しいパートナ・エントリの説明(オプション)を指定します。
bIsTrusted	この新しいパートナを信頼するかどうかを示す値。値は次のいずれかです。 信頼する場合は、true 信頼しない場合は、false

4.8.7.3 例

次の呼出しは、customPartnerを、新しいプロファイルID (x509-wss-validtemp)、説明(custom requester with new profile id)および信頼の値(false)で更新します。メッセージには、操作の結果が示されます。

updatePartner(partnerId="customPartner", partnerProfileId="x509-wss-validtemp",
description="custom requester with new profile id", bIsTrusted="false")

4.8.8 deletePartner

OSTSからパートナ・エントリを削除するオンライン・コマンド。

4.8.8.1 説明

OSTSから、partnerIdパラメータによって参照される既存のパートナ・エントリを削除し、操作の結果を出力します。

4.8.8.2 構文

deletePartner(partnerId)

引数	定義
partnerId	削除するパートナのIDを指定します。

4.8.8.3 例

次の呼出しは、OSTSから、partnerIdパラメータによって参照されるcustomPartnerパートナ・エントリを削除し、操作の結果を出力します。

deletePartner(partnerId="customPartner")

4.8.9 getPartnerUsernameTokenUsername

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのユーザー名値を取得するオンライン・コマンド。

4.8.9.1 説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのユーザー名値を取得し、値を表示します。

4.8.9.2 構文

getPartnerUsernameTokenUsername(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

4.8.9.3 例

次の呼出しは、UNT資格証明パートナ検証またはマッピング操作に使用される、customPartnerパートナ・ユーザー名値を取得し、値を表示します。

getPartnerUsernameTokenUsername(partnerId="customPartner")

4.8.10 getPartnerUsernameTokenPassword

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのパスワード値を取得するオンライン・コマンド。

4.8.10.1 説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・パスワード値を取得し、値を表示します。

4.8.10.2 構文

getPartnerUsernameTokenPassword(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

4.8.10.3 例

次の呼出しは、UNT資格証明パートナ検証またはマッピング操作に使用される、customPartnerパートナ・パスワード値を取得し、値を表示します。

getPartnerUsernameTokenPassword(partnerId="customPartner")

4.8.11 setPartnerUsernameTokenCredential

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・エントリのユーザー名およびパスワード値を設定するオンライン・コマンド。

4.8.11.1 説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・エントリのユーザー名およびパスワード値を設定します。操作の結果を表示します。

4.8.11.2 構文

setPartnerUsernameTokenCredential(partnerId, UTUsername, UTPassword)

引数	定義
partnerId	パートナのIDを指定します。
UTUsername	UNT資格証明検証またはマッピング操作に使用されるユーザー名値を指定します。
UTPassword	UNT資格証明検証またはマッピング操作に使用されるユーザー名値を指定します。

4.8.11.3 例

次の呼出しは、customPartnerパートナ・エントリのユーザー名およびパスワード値を設定し、操作の結果を表示します。

setPartnerUsernameTokenCredential(partnerId="customPartner", UTUsername="test", UTPassword="password")

4.8.12 deletePartnerUsernameTokenCredential

パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示するオンライン・コマンド。

4.8.12.1 説明

パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。

4.8.12.2 構文

deletePartnerUsernameTokenCredential(partnerId)

引数	定義
partnerId	削除するパートナのIDを指定します。

4.8.12.3 例

次の呼出しは、パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。

deletePartnerUsernameTokenCredential(partnerId="customPartner")

4.8.13 getPartnerSigningCert

partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示するオンライン・コマンド。

4.8.13.1 説明

partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。

4.8.13.2 構文

getPartnerSigningCert(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

4.8.13.3 例

次の呼出しは、partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。

getPartnerSigningCert(partnerId="customPartner")

4.8.14 getPartnerEncryptionCert

Base64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示するオンライン・コマンド。

4.8.14.1 説明

partnerIdパラメータによって参照されるパートナのBase64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。

4.8.14.2 構文

getPartnerEncryptionCert(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

4.8.14.3 例

次の呼出しは、partnerIdパラメータによって参照されるパートナのBase64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。

getPartnerEncryptionCert(partnerId="customPartner")

4.8.15 setPartnerSigningCert

提供された証明書を署名証明書としてパートナ・エントリにアップロードするオンライン・コマンド。操作の結果を表示します。

4.8.15.1 説明

提供された証明書を署名証明書として(partnerIdパラメータによって参照される)パートナ・エントリにアップロードします。サポートされている証明書の形式は、DERおよびPEMです。操作の結果を表示します。

4.8.15.2 構文

setPartnerSigningCert(partnerId, certFile)

引数	定義
partnerId	パートナのIDを指定します。
certFile	ローカル・ファイル・システム上の証明書の場所を指定します。サポートされている証明書の形式は、DERおよびPEMです。

4.8.15.3 例

次の呼出しは、提供された証明書を署名証明書としてパートナ・エントリcustomPartnerにアップロードします。操作の結果を表示します。

setPartnerSigningCert(partnerId="customPartner", certFile="/temp/signing_cert")

4.8.16 setPartnerEncryptionCert

提供された証明書を暗号化証明書としてパートナ・エントリにアップロードするオンライン・コマンド。操作の結果を表示します。

4.8.16.1 説明

提供された証明書を暗号化証明書として(partnerIdパラメータによって参照される)パートナ・エントリにアップロードします。操作の結果を表示します。

4.8.16.2 構文

setPartnerEncryptionCert(partnerId, certFile)

引数	定義
partnerId	パートナのIDを指定します。
certFile	ローカル・ファイル・システム上の証明書の場所を指定します。サポートされている証明書の形式は、DERおよびPEMです。

4.8.16.3 例

次の呼出しは、提供された証明書を署名証明書としてパートナ・エントリcustomPartnerにアップロードします。操作の結果を表示します。

setPartnerSigningCert(partnerId="customPartner", certFile="/temp/signing_cert")

4.8.17 deletePartnerSigningCert

パートナ・エントリから暗号化証明書を削除し、操作の結果を表示するオンライン・コマンド。

4.8.17.1 説明

partnerIdパラメータによって参照されるパートナ・エントリから暗号化証明書を削除し、操作の結果を表示します。

4.8.17.2 構文

deletePartnerSigningCert(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

4.8.17.3 例

次の呼出しは、パートナ・エントリcustomPartnerから暗号化証明書を削除し、操作の結果を表示します。

deletePartnerSigningCert(partnerId="customPartner")

4.8.18 deletePartnerEncryptionCert

パートナ・エントリから署名証明書を削除し、操作の結果を表示するオンライン・コマンド。

4.8.18.1 説明

partnerIdパラメータによって参照されるパートナ・エントリから署名証明書を削除し、操作の結果を表示します。

4.8.18.2 構文

deletePartnerEncryptionCert(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

4.8.18.3 例

次の呼出しは、パートナ・エントリcustomPartnerから署名証明書を削除し、操作の結果を表示します。

deletePartnerEncryptionCert(partnerId="customPartner")

4.8.19 getPartnerAllIdentityAttributes

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示するオンライン・コマンド。

4.8.19.1 説明

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。

アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです。

4.8.19.2 構文

getPartnerAllIdentityAttributes(partnerId)

引数	定義
partnerId	リクエスタ・パートナのIDを指定します。アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです

4.8.19.3 例

次の呼出しは、リクエスタ・パートナcustomPartnerにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。

getPartnerAllIdentityAttributes(partnerId="customPartner")

4.8.20 getPartnerIdentityAttribute

リクエスタ・パートナにトークンまたはバインディング・データをマップするために使用されるアイデンティティ・マッピング属性を取得して表示するオンライン・コマンド。

4.8.20.1 説明

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるアイデンティティ・マッピング属性を取得して表示します。

アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです。

4.8.20.2 構文

getPartnerIdentityAttribute(partnerId, identityAttributeName)

引数	定義
partnerId	リクエスタ・パートナのIDを指定します。
IdentityAttributeName	取得および表示するアイデンティティ・マッピング属性の名前を指定します。たとえば、httpbasicusernameです。

4.8.20.3 例

次の呼出しは、identityAttributeNameによって指定されたidentityAttributeとその値を取得して表示します。

getPartnerIdentityAttribute(partnerId="customPartner", identityAttributeName="httpbasicusername")

4.8.21 setPartnerIdentityAttribute

リクエスタ・パートナのアイデンティティ・マッピング属性を設定するオンライン・コマンド。

4.8.21.1 説明

partnerIdパラメータによって指定されたリクエスタ・タイプのパートナに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を設定します。それらのアイデンティティ・マッピング属性があるのは、リクエスタ・パートナのみです。操作の結果を表示します。

4.8.21.2 構文

setPartnerIdentityAttribute(partnerId, identityAttributeName, 
identityAttributeValue)

引数	定義
partnerId	リクエスタ・タイプのパートナのIDを指定します。
identityAttributeName	取得および表示するアイデンティティ・マッピング属性の名前を指定します。
identityAttributeValue	設定するアイデンティティ・マッピング属性の値を指定します。

4.8.21.3 例

次の呼出しは、partnerIdパラメータによって指定されたリクエスタ・タイプのリクエスタ・パートナに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を設定します。操作の結果を表示します。

setPartnerIdentityAttribute(partnerId="customPartner", 
identityAttributeName="httpbasicusername",identityAttributeValue="test")

4.8.22 deletePartnerIdentityAttribute

アイデンティティ・マッピング属性を削除するオンライン・コマンド。

4.8.22.1 説明

identityAttributeNameによって指定されたアイデンティティ・マッピング属性を削除します。

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるアイデンティティ・マッピング属性。それらの属性があるのは、リクエスタ・パートナのみです。

4.8.22.2 構文

deletePartnerIdentityAttribute(partnerId, identityAttributeName)

引数	定義
partnerId	パートナのIDを指定します。
identityAttributeName	削除するアイデンティティ・マッピング属性の名前を指定します。

4.8.22.3 例

次の呼出しは、リクエスタ・パートナcustomPartnerに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を削除します。

deletePartnerIdentityAttribute(partnerId="customPartner", 
identityAttributeName="httpbasicusername")

4.8.23 getAllWSPrefixAndPartnerMappings

リライイング・パーティ・パートナ・マッピングに対するすべてのWS接頭辞を取得して表示するオンライン・コマンド。

4.8.23.1 説明

リライイング・パーティ・パートナ・マッピングに対するすべてのWS接頭辞を取得して表示します。

4.8.23.2 構文

getAllWSPrefixAndPartnerMappings() 

4.8.23.3 例

次の呼出しは、WS接頭辞を取得して表示します。

getAllWSPrefixAndPartnerMappings() 

4.8.24 getWSPrefixAndPartnerMapping

指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示するオンライン・コマンド(そのWS接頭辞に対するマッピングが存在する場合)。

4.8.24.1 説明

指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。

4.8.24.2 構文

getWSPrefixAndPartnerMapping(wsprefix) 

引数	定義
wsprefix	取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。 http_protocol://hostname_ip/path

4.8.24.3 例

次の呼出しは、指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。

getWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path")

4.8.25 createWSPrefixAndPartnerMapping

リライイング・パートナへの新しいWS接頭辞マッピングを作成するオンライン・コマンド。

4.8.25.1 説明

partneridパラメータによって参照されるリライイング・パートナへの新しいWS接頭辞マッピングを作成し、操作の結果を表示します。

4.8.25.2 構文

createWSPrefixAndPartnerMapping(wsprefix, partnerid, description)

引数	定義
wsprefix	取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。 http_protocol://hostname_ip/path
partnerId	パートナのIDを指定します。
description	説明を指定します(オプション)。

4.8.25.3 例

次の呼出しは、partneridパラメータによって参照されるリライイング・パートナへの新しいWS接頭辞マッピングを作成し、操作の結果を表示します。

createWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path",
partnerid="customRPpartner", description="some description")

4.8.26 deleteWSPrefixAndPartnerMapping

リライイング・パートナへのWS接頭辞の既存のマッピングを削除するオンライン・コマンド。

4.8.26.1 説明

リライイング・パートナへのWS接頭辞の既存のマッピングを削除し、操作の結果を表示します。

4.8.26.2 構文

deleteWSPrefixAndPartnerMapping(wsprefix)

引数	定義
wsprefix	取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。 http_protocol://hostname_ip/path

4.8.26.3 例

次の呼出しは、リライイング・パートナへのWS接頭辞の既存のマッピングを削除し、操作の結果を表示します。

deleteWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path")

4.8.27 getAllPartnerProfiles

既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示するオンライン・コマンド。

4.8.27.1 説明

既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。

4.8.27.2 構文

getAllPartnerProfiles()

4.8.27.3 例

次の呼出しは、既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。

getAllPartnerProfiles()

4.8.28 getPartnerProfile

特定のパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示するオンライン・コマンド。

4.8.28.1 説明

partnerProfileIdパラメータによって参照されるパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。

4.8.28.2 構文

getPartnerProfile(partnerProfileId)

引数	定義
partnerProfileId	パートナ・プロファイルの名前を指定します。

4.8.28.3 例

次の呼出しは、partnerProfileIdパラメータによって参照されるパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。

getPartnerProfile(partnerProfileId="custom-partnerprofile")

4.8.29 createRequesterPartnerProfile

デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成するオンライン・コマンド。

4.8.29.1 説明

デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成し、操作の結果を表示します。

表4-9では、このコマンドで作成されるデフォルト構成について説明します。

表4-9 デフォルト構成: createRequesterPartnerProfile

要素	説明
Return Error for Missing Claims	デフォルト: false
Allow Unmapped Claims	デフォルト: false
Token Type Configuration	「トークン・タイプ構成」表には、次のエントリが含まれます。WS-Trust検証テンプレートへのトークン・タイプのマッピングはありません。 次の外部URIにマップされているSAML 1.1トークン・タイプ: http://docs.oasis-open.org/wss/oasis-wss-saml- token-profile-1.1#SAMLV1.1 SAML 1.1トークン・タイプは、どのWS-Trust検証テンプレートにもマップされません。 次の外部URIにマップされているSAML 2.0トークン・タイプ: http://docs.oasis-open.org/wss/oasis-wss-saml- token-profile-1.1#SAMLV2.0 SAML 2.0トークン・タイプは、どのWS-Trust検証テンプレートにもマップされません。 次の外部URIにマップされているユーザー名トークン・タイプ: http://docs.oasis-open.org/wss/2004/01/oasis- 200401-wss-username-token-profile-1.0#UsernameToken ユーザー名トークン・タイプは、どのWS-Trust検証テンプレートにもマップされません。 注意: トークン・タイプ構成、および検証テンプレート・マッピングに対するトークン・タイプはいずれも空になります
Attribute Name Mapping	デフォルト: Attribute Name Mapping表は、デフォルトでは空です。

4.8.29.2 構文

createRequesterPartnerProfile(partnerProfileId, defaultRelyingPartyPPID, 
description)

引数	定義
partnerProfileId	パートナ・プロファイルの名前を指定します。
defaultRelyingPartyPPID	RSTにAppliesToフィールドがない場合、またはAppliesToフィールドをリライイング・パーティ・パートナにマップできない場合に使用するリライイング・パーティ・パートナ・プロファイルを指定します。
description	このパートナ・プロファイルの説明(オプション)を指定します

4.8.29.3 例

次の呼出しは、デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成し、操作の結果を表示します。デフォルト・データの説明については、表4-9を参照してください。

createRequesterPartnerProfile(partnerProfileId="custom-partnerprofile",
defaultRelyingPartyPPID="rpPartnerProfileTest", description="custom
partner profile")

4.8.30 createRelyingPartyPartnerProfile

デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成するオンライン・コマンド。

4.8.30.1 説明

デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成し、操作の結果を表示します。

表4-10では、このコマンドで作成されるデフォルト構成について説明します。

表4-10 デフォルト構成: createRelyingPartyPartnerProfile

要素	説明
ポリシーのダウンロード	デフォルト: false
マップされていない要求を許可	デフォルト: false
トークン・タイプ構成	「トークン・タイプ構成」には、次のような単一のエントリが含まれます。 トークン・タイプが、defaultIssuanceTemplateIDによって参照される発行テンプレートのタイプに設定されている 発行テンプレートがdefaultIssuanceTemplateIDに設定されている 注意: defaultIssuanceTemplateIDによって参照される発行テンプレートのトークン・タイプは、発行テンプレートにリンクされますが、他のトークン・タイプは、どの発行テンプレートにもリンクされません。 defaultIssuanceTemplateIDによって参照される発行テンプレートがカスタム・トークン・タイプの発行テンプレートである場合、表には、外部URIとしてカスタム・トークン・タイプにマップされ、かつdefaultIssuanceTemplateIDによって参照される発行テンプレートにマップされている、カスタム・トークン・タイプの1つのエントリのみが含まれます
属性名マッピング	「属性名マッピング」表は、デフォルトでは空です。

4.8.30.2 構文

createRelyingPartyPartnerProfile(partnerProfileId, defaultIssuanceTemplateID, 
description)

引数	定義
partnerProfileId	パートナ・プロファイルの名前を指定します。
defaultIssuanceTemplateID	RSTにトークン・タイプが指定されてない場合に発行される、デフォルトの発行テンプレートおよびトークン・タイプを指定します。
description	このパートナ・プロファイルの説明(オプション)を指定します

4.8.30.3 例

次の呼出しは、デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成し、操作の結果を表示します。

createRelyingPartyPartnerProfile(partnerProfileId="custom-partnerprofile",
defaultIssuanceTemplateID="saml11-issuance-template", description="custom partner profile")

4.8.31 createIssuingAuthorityPartnerProfile

デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成するオンライン・コマンド。

4.8.31.1 説明

表4-11のデフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成し、操作の結果を表示します。

表4-11 デフォルト構成: createIssuingAuthorityPartnerProfile

要素	説明
サーバー・クロック・ドリフト	デフォルト: 600秒
トークン・マッピング	「トークン・マッピング」セクションは、次のように構成されます。 簡易ユーザー・マッピングのオーバーライド: false ユーザー名前IDマッピングのオーバーライド: false 属性ベース・ユーザー・マッピングのオーバーライド: false 簡易パートナ・マッピングのオーバーライド: false パートナ名前IDマッピングのオーバーライド: false 空のフィールド 簡易ユーザー・マッピング 属性ベース・ユーザー・マッピング 簡易パートナ・マッピング
パートナ名前IDマッピング	パートナ名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。ただし、データストア列内にデータがない場合、defaultIssuanceTemplateIDによって参照される発行テンプレートは、トークン・タイプがSAML 1.1、SAML 2.0またはユーザー名である発行テンプレートです。 この表には、次のエントリが含まれます。 urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
ユーザー名前IDマッピング	ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。 urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName、空のデータストア列 urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName、データストア列で設定されているdn urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress、データストア列で設定されているmail urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified、空のデータストア列 urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos、空のデータストア列 urn:oasis:names:tc:SAML:2.0:nameid-format:persistent、空のデータストア列
属性マッピング	「属性値マッピング」および「属性名マッピング」表は、デフォルトでは空です。

4.8.31.2 構文

createIssuingAuthorityPartnerProfile(partnerProfileId, description)

引数	定義
partnerProfileId	パートナ・プロファイルの名前を指定します。
description	このパートナ・プロファイルの説明(オプション)を指定します

4.8.31.3 例

次の呼出しは、デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成し、操作の結果を表示します。

createIssuingAuthorityPartnerProfile(partnerProfileId="custom-partnerprofile"
description="custom partner profile")

4.8.32 deletePartnerProfile

partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除するオンライン・コマンド。

4.8.32.1 説明

partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除し、操作の結果を表示します。

4.8.32.2 構文

deletePartnerProfile(partnerProfileId) 

引数	定義
partnerProfileId	削除するパートナ・プロファイルの名前を指定します。

4.8.32.3 例

次の呼出しは、partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除し、操作の結果を表示します。

deletePartnerProfile(partnerProfileId="custom-partnerprofile")

4.8.33 getAllIssuanceTemplates

既存のすべての発行テンプレートの名前を取得するオンライン・コマンド。

4.8.33.1 説明

既存のすべての発行テンプレートの名前を取得し、それらを表示します。

4.8.33.2 構文

getAllIssuanceTemplates 

4.8.33.3 例

次の呼出しは、既存のすべての発行テンプレートの名前を取得し、それらを表示します。

getAllIssuanceTemplates

4.8.34 getIssuanceTemplate

特定の発行テンプレートの構成データを取得するオンライン・コマンド。

4.8.34.1 説明

issuanceTemplateIdパラメータによって参照される発行テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

4.8.34.2 構文

getIssuanceTemplate(issuanceTemplateId) 

引数	定義
issuanceTemplateId	発行テンプレートの名前を指定します。

4.8.34.3 例

次の呼出しは、issuanceTemplateIdパラメータによって参照される発行テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

getIssuanceTemplate(issuanceTemplateId="custom-issuancetemp")

4.8.35 createIssuanceTemplate

デフォルトの構成データを使用して新しい発行テンプレートを作成するオンライン・コマンド。

4.8.35.1 説明

デフォルトの構成データを使用して新しい発行テンプレートを作成し、操作の結果を表示します。

表4-12では、このコマンドのデフォルト構成について説明します。

表4-12 デフォルト構成: createIssuanceTemplate

トークン・タイプ	説明
ユーザー名	発行テンプレートは、次のデフォルト値を使用して作成されます。 暗号化されたトークンの送信: false 名前IDユーザー属性: uid 名前IDユーザー属性ストア: ユーザー・ストア パスワード属性: (空) Nonceを含める: true タイムスタンプを含める: true
SAML 1.1 または SAML 2.0	発行テンプレートは、次のデフォルト値を使用して作成されます。 暗号化されたトークンの送信: false アサーション発行者: OAMホスト名 名前IDフォーマット: 電子メール・アドレス 名前IDユーザー属性: mail 名前IDユーザー属性ストア: ユーザー・ストア 名前ID修飾子: (空) Authn文を含める: true Attr文を含める: true アサーションの署名: true 署名に証明書を含める: true 暗号化された名前IDの送信: false (SAML 2.0のみ) デフォルト・サブジェクト確認メソッド: 送信者保証 HOK対称鍵の計算: true HOK対称鍵生成アルゴリズム: http://www.w3.org/2001/04/xmlenc#aes128-cbc 空の表: 属性名マッピング、属性値マッピングおよび属性値フィルタ
カスタム・タイプ	発行テンプレートは、次のデフォルト値を使用して作成されます。 暗号化されたトークンの送信: false

4.8.35.2 構文

createIssuanceTemplate(issuanceTemplateId, tokenType, signingKeyId, 
description) 

引数	定義
issuanceTemplateId	作成する発行テンプレートの名前を指定します。
tokenType	指定できる値は次のとおりです: username: トークン・タイプがUsernameTokenであることを示します saml11: トークン・タイプがSAML 1.1アサーションであることを示します saml20: トークン・タイプがSAML 2.0アサーションであることを示します <other>: この場合、トークン・タイプは、カスタム・トークン・タイプであると想定され、<other>によって参照されます(<other>は値で置換します)。
signingKeyId	送信SAMLアサーションに署名するために使用されるキー・エントリ(STS一般設定のUIセクションで定義されています)を参照するkeyIDを指定します。トークン・タイプがsaml11またはsaml20である場合のみ必須です。
description	説明(オプション)。

4.8.35.3 例

次の呼出しは、デフォルトの構成データを使用して新しい発行テンプレートを作成し、操作の結果を表示します。

createIssuanceTemplate(issuanceTemplateId="custom-issuancetemp", tokenType="saml20", signingKeyId="osts_signing", description="custom issuance template")

4.8.36 deleteIssuanceTemplate

issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示するオンライン・コマンド。

4.8.36.1 説明

issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。

4.8.36.2 構文

deleteIssuanceTemplate(issuanceTemplateId) 

引数	定義
issuanceTemplateId	削除する既存の発行テンプレートの名前を指定します。

4.8.36.3 例

次の呼出しは、issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。

deleteIssuanceTemplate(issuanceTemplateId="custom-issuancetemp")

4.8.37 getAllValidationTemplates

既存のすべての検証テンプレートの名前を取得するオンライン・コマンド。

4.8.37.1 説明

既存のすべての検証テンプレートの名前を取得し、それらを表示します。

4.8.37.2 構文

getAllValidationTemplates() 

4.8.37.3 例

次の呼出しは、既存のすべての検証テンプレートの名前を取得し、それらを表示します。

getAllValidationTemplates()

4.8.38 getValidationTemplate

特定の検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示するオンライン・コマンド。

4.8.38.1 説明

validationTemplateIdパラメータによって参照される検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

4.8.38.2 構文

getValidationTemplate(validationTemplateId) 

引数	定義
validationTemplateId	既存の検証テンプレートの名前を指定します。

4.8.38.3 例

次の呼出しは、特定の検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

getValidationTemplate(validationTemplateId="custom-wss-validtemp")

4.8.39 createWSSValidationTemplate

デフォルトの構成データを使用して新しい検証テンプレートを作成するオンライン・コマンド。

4.8.39.1 説明

デフォルトの構成データを使用して新しい検証テンプレートを作成し、操作の結果を表示します。

WSS検証テンプレートは、トークン・タイプに応じて表4-13の値を使用して作成されます。

表4-13 デフォルト構成: createWSSValidationTemplate

トークン・タイプ	説明
ユーザー名	検証テンプレートは、次のデフォルト値を使用して作成されます。 タイムスタンプの存続期間: 600秒 資格証明検証の有効化: true 検証ソース: パートナ トークン・マッピング: トークンの宛先パートナのマップ 簡易パートナ・マッピングの有効化: true パートナ・データストア属性: username
SAML 1.1 または SAML 2.0	検証テンプレートは、次のデフォルト値を使用して作成されます。 認証タイムアウト: 3600秒 タイムスタンプの存続期間: 3600秒 「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。 トークンのマップ: トークンの宛先パートナのマップ 簡易ユーザー・マッピングの有効化: false ユーザー名前IDマッピングの有効化: false 属性ベース・ユーザー・マッピングの有効化: false 簡易パートナ・マッピングの有効化: false パートナ名前IDマッピングの有効化: false 空のフィールド: ユーザー・トークン属性、ユーザー・データストア属性および属性ベース・ユーザー・マッピング さらに: パートナ・トークン属性: NameID パートナ・データストア属性: username パートナ名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされますが、データストア列内のデータは使用されません。 urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos urn:oasis:names:tc:SAML:2.0:nameid-format:persistent ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。 urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName、空のデータストア列 urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName、データストア列で設定されているdn urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress、データストア列で設定されているmail urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified、空のデータストア列 urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos、空のデータストア列 urn:oasis:names:tc:SAML:2.0:nameid-format:persistent、空のデータストア列
X.509	「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。 トークンのマップ: トークンの宛先パートナのマップ 簡易ユーザー・マッピングの有効化: false 属性ベース・ユーザー・マッピングの有効化: false 簡易パートナ・マッピングの有効化: true 空のフィールド: ユーザー・トークン属性、ユーザー・データストア属性および属性ベース・ユーザー・マッピング さらに: パートナ・トークン属性: DN パートナ・データストア属性: sslclientcertdn
Kerberos	「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。 トークンのマップ: トークンの宛先ユーザーのマップ 簡易ユーザー・マッピングの有効化: true 属性ベース・ユーザー・マッピングの有効化: false 簡易パートナ・マッピングの有効化: false 空のフィールド: パートナ・トークン属性、パートナ・データストア属性および属性ベース・ユーザー・マッピング さらに: ユーザー・トークン属性: TPE_KERBEROS_PRINCIPAL_FULL ユーザー・データストア属性: mail

4.8.39.2 構文

createWSSValidationTemplate(templateId, tokenType,
defaultRequesterPPID, description)

引数	定義
templateId	作成する検証テンプレートの名前を指定します。
tokenType	検証テンプレートのトークン・タイプを指定します。指定できる値は次のとおりです: username: トークン・タイプがUsernameTokenであることを示します saml11: トークン・タイプがSAML 1.1アサーションであることを示します saml20: トークン・タイプがSAML 2.0アサーションであることを示します x509: トークン・タイプがX.509証明書であることを示します kerberos: トークン・タイプがKerberosトークンであることを示します oam: トークン・タイプがOAMであることを示します。
defaultRequesterPPID	OSTSが着信メッセージをリクエスタにマップしないように構成されている場合に使用するリクエスタ・パートナ・プロファイルを指定します。
description	説明を指定します(オプション)。

4.8.39.3 例

次の呼出しは、デフォルトの構成データを使用して新しい検証テンプレートを作成し、操作の結果を表示します。

createWSSValidationTemplate(templateId="custom-wss-validtemp", tokenType="custom",
defaultRequesterPPID="requesterPartnerProfileTest", description="custom validation 
template")

4.8.40 createWSTrustValidationTemplate

デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成するオンライン・コマンド。

4.8.40.1 説明

デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成し、操作の結果を表示します。

WS-Trust検証テンプレートは、トークン・タイプに応じて表4-14の値を使用して作成されます。

表4-14 デフォルト構成: createWSTrustValidationTemplate

トークン・タイプ	説明
ユーザー名	WS-Trust検証テンプレートは、次のデフォルト値を使用して作成されます。 タイムスタンプの存続期間: 600秒 資格証明検証の有効化: false 検証ソース: ユーザー・ストア トークン・マッピング: トークンの宛先ユーザーのマップ 簡易ユーザー・マッピングの有効化: true ユーザー・データストア属性: uid
SAML 1.1 または SAML 2.0	WS-Trust検証テンプレートは、次のデフォルト値を使用して作成されます。 認証タイムアウト: 3600秒 タイムスタンプの存続期間: 3600秒 「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。 トークンのマップ: トークンの宛先ユーザーのマップ 簡易ユーザー・マッピングの有効化: false ユーザー名前IDマッピングの有効化: true 属性ベース・ユーザー・マッピングの有効化: false 空のフィールド: ユーザー・データストア属性、属性ベース・ユーザー・マッピング ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。 urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName、空のデータストア列 urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName、データストア列で設定されているdn urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress、データストア列で設定されているmail urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified、空のデータストア列 urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos、空のデータストア列 urn:oasis:names:tc:SAML:2.0:nameid-format:persistent、空のデータストア列
X.509	WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。 トークンのマップ: トークンの宛先ユーザーのマップ 簡易ユーザー・マッピングの有効化: true 属性ベース・ユーザー・マッピングの有効化: false 簡易パートナ・マッピングの有効化: true ユーザー・トークン属性: CN ユーザー・データストア属性: CN 属性ベース・ユーザー・マッピング(空)
Kerberos	WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。 トークンのマップ: トークンの宛先ユーザーのマップ 簡易ユーザー・マッピングの有効化: true 属性ベース・ユーザー・マッピングの有効化: false 属性ベース・ユーザー・マッピング(空) ユーザー・トークン属性: TPE_KERBEROS_PRINCIPAL_FULL ユーザー・データストア属性: mail
OAM	WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。 トークンのマップ: トークンの宛先ユーザーのマップ 簡易ユーザー・マッピングの有効化: true 属性ベース・ユーザー・マッピングの有効化: false 属性ベース・ユーザー・マッピング(空) ユーザー・トークン属性: TPE_NAME_ID ユーザー・データストア属性: uid
custom	WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。 トークンのマップ: いずれの宛先にもマップしない 簡易ユーザー・マッピングの有効化: false 属性ベース・ユーザー・マッピングの有効化: false 属性ベース・ユーザー・マッピング(空) ユーザー・トークン属性: (空) ユーザー・データストア属性: (空)

4.8.40.2 構文

createWSTrustValidationTemplate(templateId, tokenType, description)

引数	定義
templateId	作成するWS-Trust検証テンプレートの名前を指定します。
tokenType	WS-Trust検証テンプレートのトークン・タイプを指定します。指定できる値は次のとおりです: username: トークン・タイプがUsernameTokenであることを示します saml11: トークン・タイプがSAML 1.1アサーションであることを示します saml20: トークン・タイプがSAML 2.0アサーションであることを示します x509: トークン・タイプがX.509証明書であることを示します kerberos: トークン・タイプがKerberosトークンであることを示します oam: トークン・タイプが(デフォルトでサポートされている)Oracle Access Managerトークンであることを示します。 <other>: この場合、トークン・タイプは、カスタム・トークン・タイプであると想定され、<other>によって参照されます(<other>は値で置換します)。
description	説明を指定します(オプション)。

4.8.40.3 例

次の呼出しは、デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成し、操作の結果を表示します。

createWSTrustValidationTemplate(templateId="custom-wss-validtemp", 
tokenType="custom", description="custom validation template")

4.8.41 deleteValidationTemplate

検証テンプレートを削除するオンライン・コマンド。

4.8.41.1 説明

validationTemplateIdパラメータによって参照される検証テンプレートを削除し、操作の結果を表示します。

4.8.41.2 構文

deleteValidationTemplate(validationTemplateId)

引数	定義
validationTemplateId	削除する検証テンプレートの名前を指定します。

4.8.41.3 例

次の呼出しは、validationTemplateIdパラメータによって参照される検証テンプレートを削除し、操作の結果を表示します。

deleteValidationTemplate(validationTemplateId="custom-wss-validtemp") 

4.9 Oracleキーストア・サービス

この項では、OPSSキーストア・サービスで使用されるコマンドについて説明します。

注意: キーストア・サービス・コマンドを使用するには、OPSSハンドルを取得する必要があります。詳細は、『Oracle Fusion Middlewareアプリケーション・セキュリティ・ガイド』のキーストア・サービスによるキーと証明書の管理に関する項を参照してください。

表4-15では、キーストア・サービスを管理するために使用されるWLSTコマンドを示します。

表4-15 OPSSキーストア・サービス・コマンド

このコマンドを使用します...	次を行うには...
changeKeyPassword	キーのパスワードを変更します。
changeKeyStorePassword	キーストアのパスワードを変更します。
createKeyStore	キーストアを作成します。
deleteKeyStore	キーストアを削除します。
deleteKeyStoreEntry	キーストア内のエントリを削除します。
exportKeyStore	キーストアをファイルにエクスポートします。
exportKeyStoreCertificate	証明書をファイルにエクスポートします。
exportKeyStoreCertificateRequest	証明書リクエストをファイルにエクスポートします。
generateKeyPair	鍵ペアを生成します。
generateSecretKey	秘密鍵を生成します。
getKeyStoreCertificates	証明書または信頼できる証明書に関する情報を取得します。
getKeyStoreSecretKeyProperties	秘密鍵プロパティを取得します。
importKeyStore	ファイルからキーストアをインポートします。
importKeyStoreCertificate	証明書または他のオブジェクトをインポートします。
listExpiringCertificates	指定された期間内に期限切れとなる証明書を一覧表示します。
listKeyStoreAliases	キーストア内の別名を一覧表示します。
listKeyStores	ストライプ内のすべてのキーストアを一覧表示します。

4.9.1 changeKeyPassword

キーのパスワードを変更します。

4.9.1.1 説明

キーのパスワードを変更します。

4.9.1.2 構文

svc.changeKeyPassword(appStripe='stripe', name='keystore', password='password', 
alias='alias', currentkeypassword='currentkeypassword', 
newkeypassword='newkeypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを含むストライプの名前を指定します
name	キーストアの名前を指定します
password	キーストアのパスワードを指定します
alias	パスワードを変更するキー・エントリの別名を指定します
currentkeypassword	キーの現在のパスワードを指定します
newkeypassword	キーの新しいパスワードを指定します

4.9.1.3 例

この例では、キー・エントリorakeyのパスワードを変更します。

svc.changeKeyPassword(appStripe='system', name='keystore', password='password', 
alias='orakey', currentkeypassword='currentkeypassword', 
newkeypassword='newkeypassword')

4.9.2 changeKeyStorePassword

キーストアのパスワードを変更します。

4.9.2.1 説明

指定されたキーストアのパスワードを変更します。

4.9.2.2 構文

svc.changeKeyStorePassword(appStripe='stripe', name='keystore', currentpassword='currentpassword', newpassword='newpassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを含むストライプの名前を指定します
name	キーストアの名前を指定します
currentpassword	キーストアの現在のパスワードを指定します
newpassword	キーストアの新しいパスワードを指定します

4.9.2.3 例

この例では、keystore2のパスワードを変更します。

svc.changeKeyStorePassword(appStripe='system', name='keystore2', 
currentpassword='currentpassword', newpassword='newpassword')

4.9.3 createKeyStore

このキーストア・サービス・コマンドは、新しいキーストアを作成します。

4.9.3.1 説明

指定されたアプリケーション・ストライプに新しいキーストアを作成します。

4.9.3.2 構文

svc.createKeyStore(appStripe='stripe', name='keystore', password='password',permission=true|false)

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが作成されるストライプの名前を指定します。
name	新しいキーストアの名前を指定します。
password	キーストアのパスワードを指定します。
permission	キーストアがパーミッションによってのみ保護される場合、このパラメータはtrueです。パーミッションとパスワードの両方によって保護される場合はfalseです。

4.9.3.3 例

この例では、keystore1という名前のキーストアを作成します。

svc.createKeyStore(appStripe='system', name='keystore1', password='password', permission=true)

4.9.4 deleteKeyStore

指定されたキーストアを削除します。

4.9.4.1 説明

このキーストア・サービス・コマンドは、指定されたキーストアを削除します。

4.9.4.2 構文

svc.deleteKeyStore(appStripe='stripe', name='keystore', password='password')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	削除するキーストアの名前を指定します。
password	キーストアのパスワードを指定します。

4.9.4.3 例

この例では、keystore1という名前のキーストアを削除します。

svc.deleteKeyStore(appStripe='system', name='keystore1', password='password')

4.9.5 deleteKeyStoreEntry

キーストア・エントリを削除します。

4.9.5.1 説明

このコマンドは、キーストア内の指定されたエントリを削除します。

4.9.5.2 構文

svc.deleteKeyStoreEntry(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	削除するエントリの別名を指定します
keypassword	削除するエントリのキー・パスワードを指定します

4.9.5.3 例

この例では、別名orakeyで表されるキーストア・エントリを削除します。

svc.deleteKeyStoreEntry(appStripe='system', name='keystore2', password='password', alias='orakey', keypassword='keypassword')

4.9.6 exportKeyStore

キーストアをファイルにエクスポートします。

4.9.6.1 説明

指定されたファイルにキーストアをエクスポートします。

4.9.6.2 構文

svc.exportKeyStore(appStripe='stripe', name='keystore', password='password', 

aliases='comma-separated-aliases', keypasswords='comma-separated-keypasswords', 
type='keystore-type', filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
aliases	エクスポートする別名のカンマ区切りのリスト。
keypasswords	別名に対応するキー・パスワードのカンマ区切りのリスト。
type	エクスポートされるキーストアのタイプ。有効な値は、JKSまたはJCEKSです。
filepath	キーストアのエクスポート先となるファイルの絶対パス。

4.9.6.3 例

この例では、指定されたキーストアから2つの別名をエクスポートします。

svc.exportKeyStore(appStripe='system', name='keystore2', 
password='password',aliases='orakey,seckey', 
keypasswords='keypassword1,keypassword2', 
type='JKS',filepath='/tmp/file.jks')

4.9.7 exportKeyStoreCertificate

証明書をエクスポートします。

4.9.7.1 説明

証明書、信頼できる証明書または証明書チェーンをエクスポートします。

4.9.7.2 構文

svc.exportKeyStoreCertificate(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword', 
type='entrytype',filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	エクスポートするエントリの別名を指定します
keypassword	キー・パスワードを指定します。
type	エクスポートするキーストア・エントリのタイプを指定します。有効な値は、Certificate、TrustedCertificateまたはCertificateChainです。
filepath	証明書、信頼できる証明書または証明書チェーンのエクスポート先となるファイルの絶対パスを指定します。

4.9.7.3 例

この例では、別名orakeyに対応する証明書をエクスポートします。

svc.exportKeyStoreCertificate(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
type='Certificate', filepath='/tmp/cert.txt')

4.9.8 exportKeyStoreCertificateRequest

証明書リクエストをエクスポートします。

4.9.8.1 説明

証明書リクエストを生成し、キーストアからエクスポートします。

4.9.8.2 構文

svc.exportKeyStoreCertificateRequest(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword', 
filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	エントリの別名を指定します。
keypassword	キー・パスワードを指定します。
filepath	証明書リクエストのエクスポート先となるファイルの絶対パスを指定します。

4.9.8.3 例

この例では、別名orakeyに対応する証明書リクエストをエクスポートします。

svc.exportKeyStoreCertificateRequest(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
filepath='/tmp/certreq.txt')

4.9.9 generateKeyPair

キーストアに鍵ペアを生成します。

4.9.9.1 説明

キーストアに鍵ペアを生成し、デモCA署名証明書にラップします。

4.9.9.2 構文

svc.generateKeyPair(appStripe='stripe', name='keystore', password='password', 
dn='distinguishedname', keysize='keysize', alias='alias', 
keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
dn	鍵ペアをラップする証明書の識別名を指定します。
keysize	キー・サイズを指定します。
alias	鍵ペア・エントリの別名を指定します。
keypassword	キー・パスワードを指定します。

4.9.9.3 例

この例では、keystore2に鍵ペアを生成します。

svc.generateKeyPair(appStripe='system', name='keystore2', password='password', dn='cn=www.oracle.com', keysize='1024', alias='orakey', keypassword='keypassword')

4.9.10 generateSecretKey

秘密鍵を生成します。

4.9.10.1 説明

キーストアに対称鍵を生成します。

4.9.10.2 構文

svc.generateSecretKey(appStripe='stripe', name='keystore', password='password', 
algorithm='algorithm', keysize='keysize', alias='alias', 
keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
algorithm	対称鍵のアルゴリズムを指定します。
keysize	キー・サイズを指定します。
alias	キー・エントリの別名を指定します。
keypassword	キー・パスワードを指定します。

4.9.10.3 例

この例では、keystore2にキー・サイズ128の鍵ペアを生成します。

svc.generateSecretKey(appStripe='system', name='keystore2', password='password', 
algorithm='AES', keysize='128', alias='seckey', keypassword='keypassword')

4.9.11 getKeyStoreCertificates

キーストアから証明書を取得します。

4.9.11.1 説明

証明書または信頼できる証明書に関する情報を取得します。

4.9.11.2 構文

svc.getKeyStoreCertificates(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	表示する証明書、信頼できる証明書または証明書チェーンの別名を指定します。
keypassword	キー・パスワードを指定します。

4.9.11.3 例

この例では、keystore3に関連付けられている証明書を取得します。

svc.getKeyStoreCertificates(appStripe='system', name='keystore3', password='password', alias='orakey', keypassword='keypassword')

4.9.12 getKeyStoreSecretKeyProperties

秘密鍵のプロパティを取得します。

4.9.12.1 説明

アルゴリズムなどの秘密鍵のプロパティを取得します。

4.9.12.2 構文

svc.getKeyStoreSecretKeyProperties(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	プロパティを表示する秘密鍵の別名を指定します。
keypassword	秘密鍵のパスワードを指定します。

4.9.12.3 例

この例では、秘密鍵seckeyのプロパティを取得します。

svc.getKeyStoreSecretKeyProperties(appStripe='system', name='keystore3', 
password='password', alias='seckey', keypassword='keypassword')

4.9.13 importKeyStore

ファイルからキーストアをインポートします。

4.9.13.1 説明

システム・ファイルからキーストアをインポートします。

4.9.13.2 構文

svc.importKeyStore(appStripe='stripe', name='keystore', password='password', 
aliases='comma-separated-aliases', keypasswords='comma-separated-keypasswords', 
type='keystore-type', permission=true|false, filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
aliases	ファイルからインポートするエントリのカンマ区切りの別名を指定します。
keypasswords	ファイル内のキーのカンマ区切りのパスワードを指定します。
type	インポートされるキーストアのタイプを指定します。有効な値は、JKSまたはJCEKSです。
filepath	インポートするキーストア・ファイルの絶対パスを指定します。
permission	キーストアがパーミッションによってのみ保護される場合はtrue、パーミッションとパスワードの両方によって保護される場合はfalseを指定します。

4.9.13.3 例

この例では、keystore2にファイルをインポートします。

svc.importKeyStore(appStripe='system', name='keystore2', 
password='password',aliases='orakey,seckey', keypasswords='keypassword1, 
keypassword2', type='JKS', permission=true, filepath='/tmp/file.jks')

4.9.14 importKeyStoreCertificate

証明書または指定された他のオブジェクトをインポートします。

4.9.14.1 説明

証明書、信頼できる証明書または証明書チェーンをインポートします。

4.9.14.2 構文

svc.importKeyStoreCertificate(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword', 
type='entrytype',filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	インポートするエントリの別名を指定します。
keypassword	新たにインポートされるエントリのキー・パスワードを指定します。
type	インポートするキーストア・エントリのタイプを指定します。有効な値は、Certificate、TrustedCertificateまたはCertificateChainです。
filepath	証明書、信頼できる証明書または証明書チェーンのインポート元となるファイルの絶対パスを指定します。

4.9.14.3 例

この例では、keystore2に証明書をインポートします。

svc.importKeyStoreCertificate(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
type='Certificate', filepath='/tmp/cert.txt')

4.9.15 listExpiringCertificates

期限切れになる証明書を一覧表示します。

4.9.15.1 説明

期限切れになる証明書を一覧表示し、オプションでそれらの期限を更新します。

4.9.15.2 構文

svc.listExpiringCertificates(days='days', autorenew=true|false)

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
days	日数を指定します。リストには、指定された日数内に期限切れとなる証明書のみが含まれます。
autorenew	期限切れとなる証明書を自動的に更新する場合はtrue、それらを一覧表示するのみの場合はfalseを指定します。

4.9.15.3 例

この例では、1年以内に期限切れとなる証明書を一覧表示し、それらの更新を要求します。

svc.listExpiringCertificates(days='365', autorenew=true)

4.9.16 listKeyStoreAliases

キーストア内の別名を一覧表示します。

4.9.16.1 説明

キーストア内の、指定されたエントリ・タイプの別名を一覧表示します。

4.9.16.2 構文

構文は次のとおりです:

svc.listKeyStoreAliases(appStripe='stripe', name='keystore', 
password='password', type='entrytype')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
type	別名を一覧表示するエントリのタイプを指定します。有効な値は、Certificate、TrustedCertificate、SecretKeyまたは*です。

4.9.16.3 例

この例では、keystore2内の秘密鍵を一覧表示します。

svc.listKeyStoreAliases(appStripe='system', name='keystore2', 
password='password', type='SecretKey')

4.9.17 listKeyStores

ストライプ内のすべてのキーストアを一覧表示します。

4.9.17.1 説明

指定されたストライプ内のすべてのキーストアを一覧表示します。

4.9.17.2 構文

svc.listKeyStores(appStripe='stripe')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを一覧表示するストライプの名前を指定します。

4.9.17.3 例

この例では、すべてのストライプ上のすべてのキーストアを一覧表示します。

svc.listKeyStores(appStripe='*')

4.10 Library Oracle Virtual Directory (libOVD)コマンド

表4-16に示されているWLSTコマンドを使用して、特定のOracle Platform Security Services (OPSS)コンテキストに関連付けられているlibOVD構成を管理します。

表4-16 WLST libOVDコマンド

コマンド	用途	WLSTでの使用
addDNAttribute	既存のアダプタのDN属性リストに属性を追加します。	オンライン
activateLibOVDConfigChanges	LibOVD構成を再ロードします。	オンライン
addAttributeExclusionRule	属性除外ルールを追加します。	オンライン
addAttributeRule	新しい属性マッピング・ルールを追加します。	オンライン
addDomainExclusionRule	ドメイン除外ルールを追加します。	オンライン
addDomainRule	新しいドメイン・マッピング・ルールを追加します。	オンライン
addJoinRule	libOVD構成の既存の結合アダプタに結合ルールを追加します。	オンライン
addLDAPHost	既存のLDAPアダプタに新しいリモート・ホストを追加します。	オンライン
addMappingContext	新しいマッピング・コンテキストを作成します。	オンライン
addPlugin	既存のアダプタに、またはグローバル・レベルでプラグインを追加します。	オンライン
addPluginParam	既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します。	オンライン
addToRequestControlExcludeList	既存のLDAPアダプタ構成のリクエスト制御除外リストにコントロールを追加します。	オンライン
addToRequestControlIncludeList	既存のLDAPアダプタ構成のリクエスト制御対象リストにコントロールを追加します。	オンライン
assignViewToAdapter	指定されたビューをアダプタに割り当てます。	オンライン
createJoinAdapter	libOVD構成の新しい結合アダプタを作成します。	オンライン
createLDAPAdapter	libOVD構成の新しいLDAPアダプタを作成します。	オンライン
createLDAPAdapterWithDefaultPlugins	指定されたディレクトリ・タイプに基づいて、デフォルトのプラグインで新しいLDAPアダプタを作成します。	オンライン
createView	新しいビューを作成します。	オンライン
deleteAdapter	libOVD構成の既存のアダプタを削除します。	オンライン
deleteAttributeExclusionRule	属性除外ルールを削除します。	オンライン
deleteAttributeRule	属性マッピング・ルールを削除します。	オンライン
deleteDomainExclusionRule	ドメイン除外ルールを削除します。	オンライン
deleteDomainRule	ドメイン・マッピング・ルールを削除します。	オンライン
deleteMappingContext	指定されたマッピング・コンテキストを削除します。	オンライン
deleteView	指定されたビューを削除します。	オンライン
getAdapterDetails	libOVD構成の既存のアダプタの詳細を表示します。	オンライン
listAdapters	libOVD構成用に構成されているすべてのアダプタの名前とタイプを一覧表示します。	オンライン
listAllMappingContextIds	すべてのマッピング・コンテキストを一覧表示します。	オンライン
listAttributeRules	すべての属性ルールを一覧表示します。	オンライン
listDomainRules	すべてのドメイン・ルールを一覧表示します。	オンライン
listViews	すべてのビューを一覧表示します。	オンライン
modifyLDAPAdapter	既存のLDAPアダプタ構成を変更します。	オンライン
modifySocketOptions	既存のLDAPアダプタ構成のソケット・オプションを変更します。	オンライン
removeAllRequestControlExcludeList	既存のLDAPアダプタ構成のリクエスト制御除外リストからすべてのコントロールを削除します。	オンライン
removeAllRequestControlIncludeList	既存のLDAPアダプタ構成のリクエスト制御対象リストからすべてのコントロールを削除します。	オンライン
removeFromRequestControlExcludeList	既存のLDAPアダプタ構成のDN属性リストから属性を削除します。	オンライン
removeDNAttribute	既存のLDAPアダプタ構成のリクエスト制御除外リストからコントロールを削除します。	オンライン
removeFromRequestControlIncludeList	既存のLDAPアダプタ構成のリクエスト制御対象リストからコントロールを削除します。	オンライン
removeJoinRule	libOVD構成用に構成されている結合アダプタから結合ルールを削除します。	オンライン
removeLDAPHost	既存のLDAPアダプタ構成からリモート・ホストを削除します。	オンライン
removePlugin	既存のアダプタから、またはグローバル・レベルでプラグインを削除します。	オンライン
removePluginParam	構成済のアダプタ・レベル・プラグインまたはグローバル・プラグインから既存のパラメータを削除します。	オンライン
replacePluginParam	アダプタ・レベル・プラグインまたはグローバル・プラグインの既存のパラメータ値を置換します。	オンライン
unassignViewFromAdapter	アダプタからビューを削除します。	オンライン
listSSLStoreType	libOVD用に使用されているSSLストアのタイプをリストします。	オンライン
enableKSSForSSL	KSSをlibOVD用に有効化します。	オンライン
enableJKSForSSL	JKSをlibOVD用に有効化します。	オンライン
createKeyStoreAndEnableJKSForSSL	JKSをlibOVD用に有効化します。	オンライン
importTrustedCertificateIntoSSLStore	所定の信頼できる証明書をSSLストアにインポートします。	オンライン
migrateAllTrustedCertificatesFromJKSToKSS	すべての信頼できる証明書をJKSからKSSストアに移行します。	オンライン
migrateTrustedCertificatesFromJKSToKSS	指定の信頼できる証明書をJKSからKSSストアに移行します。	オンライン
changeLDAPHostPort	既存のLDAPアダプタ構成内にある指定のLDAPホストとポートを、新しいホストとポートに変更します。	オンライン
removeLDAPHostPort	既存のLDAPアダプタ構成からリモート・ホストとポートを削除します。	オンライン
setReadOnlyForLDAPHost	既存のLDAPアダプタ構成内の指定のホストとポートを読取り専用または書き込み可能に設定します。	オンライン

4.10.1 addDNAttribute

DN属性リストに属性を追加します。

4.10.1.1 説明

OPSSコンテキストに関連付けられたlibOVD構成用に構成されている既存のアダプタのDN属性リストに属性を追加します。

4.10.1.2 構文

addDNAttribute(adapterName, attributeName, [contextName])

引数	定義
adapterName	更新するアダプタの名前。
attributeName	追加する新しいDN属性の名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値は"default"です。

4.10.1.3 例

addDNAttribute(adapterName='ldap1', attributeName='memberof', contextName='default')

4.10.2 activateLibOVDConfigChanges

LibOVD構成を再ロードします。

4.10.2.1 説明

特定のOPSSコンテキストに関連付けられているlibOVD構成を再ロードします。

4.10.2.2 構文

activateLibOVDConfigChanges([contextName])

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.2.3 例

activateLibOVDConfigChanges('default')

4.10.3 addAttributeExclusionRule

属性除外ルールを追加します。

4.10.3.1 説明

除外リストに属性除外ルールを追加します。

4.10.3.2 構文

addAttributeExclusionRule(attribute, mappingContextId, [contextName])

引数	定義
attribute	除外リストに追加する属性の名前。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.3.3 例

addAttributeExclusionRule('objectsid','userrole')

4.10.4 addAttributeRule

新しい属性マッピング・ルールを追加します。

4.10.4.1 説明

特定のOPSSコンテキストに関連付けられているlibOVD構成に新しい属性マッピング・ルールを追加します。

4.10.4.2 構文

addAttributeRule(srcAttrs, srcObjectClass, srcAttrType, dstAttr, dstObjectClass, dstAttrType, mappingExpression, direction, mappingContextId, [contextName])

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.4.3 例

addAttributeRule('lastname','','','sn','','','','Inbound','userrole')

4.10.5 addDomainExclusionRule

ドメイン除外ルールを追加します。

4.10.5.1 説明

除外リストにドメイン除外ルールを追加します。

4.10.5.2 構文

addDomainExclusionRule(domain, mappingContextId, [contextName])

引数	定義
domain	除外リストに追加する属性の識別名(DN)。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.5.3 例

addDomainExclusionRule('cn=group,dc=oracle,dc=com','userrole')

4.10.6 addDomainRule

新しいドメイン・マッピング・ルールを追加します。

4.10.6.1 説明

新しいドメイン・マッピング・ルールを追加します。

4.10.6.2 構文

addDomainRule(srcDomain, destDomain, domainConstructRule, mappingContextId, [contextName])

引数	定義
srcDomain	ソース・ドメイン。
destDomain	宛先ドメイン。
domainConstructRule	除外リストに追加する属性の名前。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.6.3 例

addDomainRule('dc=oracle,dc=com', 'dc=oracle,dc=com', '', 'defaultContext', 'default')

4.10.7 addJoinRule

結合アダプタに結合ルールを追加します。

4.10.7.1 説明

指定されたOPSSコンテキストに関連付けられているlibOVD構成の既存の結合アダプタに結合ルールを追加します。

4.10.7.2 構文

addJoinRule(adapterName, secondary, condition, [joinerType], [contextName])

引数	定義
adapterName	変更する結合アダプタの名前。
secondary	結合先のアダプタの名前。
condition	結合する属性。
joinerType	オプション。結合のタイプを定義します。指定可能な値は、Simple(デフォルト)、Conditional、OneToManyまたはShadowです。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.7.3 例

addJoinRule('join1','secondaryldap','cn=cn', 'Simple', 'default')

addJoinRule('join1','secondaryldap','cn=cn', 'Conditional', 'default')

addJoinRule(adapterName='join1', secondary='LDAP3', condition='uid=cn', joinerType='OneToMany')

addJoinRule(adapterName='join1', secondary='LDAP2',condition='uid=cn', contextName='myContext')

4.10.8 addLDAPHost

新しいリモート・ホストを追加します。

4.10.8.1 説明

既存のLDAPアダプタに新しいリモート・ホスト(ホストおよびポート)を追加します。デフォルトでは、新しいホストは、読取り-書込みモード(パーセンテージは100に設定されます)で構成されます。

4.10.8.2 構文

addLDAPHost(adapterName, host, port, [contextName])

引数	定義
adapterName	変更する結合アダプタの名前。
host	LDAPアダプタの通信先となるリモートLDAPホスト。
port	リモートLDAPホストのポート。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.8.3 例

addLDAPHost(adapterName='ldap1', host='myhost.example.com', port=389)

addLDAPHost('ldap1', 'myhost.example.com',389, 'myContext')

4.10.9 addMappingContext

新しいマッピング・コンテキストを作成します。

4.10.9.1 説明

指定されたOPSSコンテキストに関連付けられているlibOVD構成の新しいマッピング・コンテキストを作成します。

4.10.9.2 構文

addMappingContext(mappingContextId, [contextName])

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.9.3 例

addMappingContext('defaultContext','context')

4.10.10 addPlugin

既存のアダプタに、またはグローバル・レベルでプラグインを追加します。

4.10.10.1 説明

既存のアダプタに、またはグローバル・レベルでプラグインを追加します。i番目のキーはi番目の値に対応しています。プラグインは、デフォルト・チェーンに追加されます。

4.10.10.2 構文

addPlugin(pluginName, pluginClass, paramKeys, paramValues, [adapterName], [contextName])

引数	定義
pluginName	作成するプラグインの名前。
pluginClass	プラグインのクラス。
paramKeys	初期化パラメータ。「|」で区切られたキー。
paramValues	初期化パラメータ。「|」で区切られた値。
adapterName	オプション。変更するアダプタの名前。指定しない場合、プラグインはグローバル・レベルで追加されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.10.3 例

addPlugin(adapterName='ldap1', pluginName='VirtualAttr',pluginClass='oracle.ods.virtualization.engine.chain.plugins.virtualattr.VirtualAttributePlugin', paramKeys='AddAttribute | MatchFilter | ContainerDN', paramValues='cn=%uid% | objectclass=person | dc=oracle,dc=com')

addPlugin(pluginName='VirtualAttr',pluginClass='oracle.ods.virtualization.engine.chain.plugins.virtualattr.VirtualAttributePlugin', paramKeys='AddAttribute | MatchFilter | ContainerDN', paramValues='cn=%uid% | objectclass=person | dc=oracle,dc=com') 

addPlugin(pluginName='DMSMetrics',pluginClass='oracle.ods.virtualization.engine.chain.plugins.DMSMetrics.MonitorPerformance', paramKeys='None',paramValues='None',adapterName='ldap1',contextName='default')

4.10.11 addPluginParam

既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します。

4.10.11.1 説明

既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します。パラメータがすでに存在している場合、既存の値のセットに新しい値が追加されます。i番目のキーはi番目の値に対応しています。

4.10.11.2 構文

addPluginParam(pluginName, paramKeys, paramValues, [adapterName], [contextName])

引数	定義
pluginName	変更するプラグインの名前。
paramKeys	|で区切られた初期化パラメータ・キー。
paramValues	|で区切られた初期化パラメータ値。
adapterName	オプション。変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.11.3 例

addPluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', paramValues='cn=%uid% | objectclass=person')

addPluginParam(pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', par)

4.10.12 addToRequestControlExcludeList

リクエスト制御除外リストにコントロールを追加します。

4.10.12.1 説明

既存のLDAPアダプタ構成のリクエスト制御除外リストにコントロールを追加します。

4.10.12.2 構文

addToRequestControlExcludeList(adapterName, control, [contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
control	LDAPコントロール・オブジェクト識別子(OID)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.12.3 例

addToRequestControlExcludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

4.10.13 addToRequestControlIncludeList

リクエスト制御対象リストにコントロールを追加します。

4.10.13.1 説明

既存のLDAPアダプタ構成のリクエスト制御対象リストにコントロールを追加します。

4.10.13.2 構文

addToRequestControlIncludeList(adapterName, control, [contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
control	LDAPコントロール・オブジェクト識別子(OID)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.13.3 例

addToRequestControlIncludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

4.10.14 assignViewToAdapter

LDAPアダプタにビューを割り当てます。

4.10.14.1 説明

OPSSコンテキストに関連付けられたlibOVD構成内のLDAPアダプタにビューを割り当てます。

4.10.14.2 構文

assignViewToAdapter(viewName, adapterName, [contextName])

引数	定義
viewName	ビューの名前。
adapterName	LDAPアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.14.3 例

assignViewToAdapter('userView','ldap1', 'default')

4.10.15 createJoinAdapter

新しい結合アダプタを作成します。

4.10.15.1 説明

OPSSコンテキストに関連付けられたlibOVD構成の新しい結合アダプタを作成します。

4.10.15.2 構文

createJoinAdapter(adapterName, root, primaryAdapter, [bindAdapter],[contextName])

引数	定義
adapterName	作成する結合アダプタの名前。
root	ルート。
primaryAdapter	プライマリ・アダプタ(結合操作で最初に検索されるアダプタ)の識別子を指定します。
bindAdapter	バインド・アダプタ(LDAP操作でプロキシ・アカウントがバインドに使用されるアダプタ)の識別子を指定します。デフォルトでは、primaryAdapterは、bindAdapterと設定されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.15.3 例

createJoinAdapter('join1','dc=join','primaryldap','myldap', 'myContext')

createJoinAdapter(adapterName='join1', root='dc=join', primaryAdapter='myldap')

4.10.16 createLDAPAdapter

新しいLDAPアダプタを作成します。

4.10.16.1 説明

OPSSコンテキストに関連付けられたlibOVD構成の新しいLDAPアダプタを作成します。

4.10.16.2 構文

createLDAPAdapter(adapterName, root, host, port, remoteBase, [isSecure], [bindDN], [bindPasswd], [passCred], [contextName])

引数	定義
adapterName	作成するLDAPアダプタの名前。
root	LDAPアダプタの仮想ネームスペース。
host	LDAPアダプタの通信先となるリモートLDAPホスト。
port	リモートLDAPホストのポート番号。
remoteBase	ルートが対応するリモートDIT内の場所。
isSecure	オプション。trueに設定された場合、リモート・ホストへのセキュアなSSL/TLS接続を可能にするブール値。デフォルト値はfalseです。
bindDN	オプション。リモート・ホストとの通信に使用されるプロキシのBindDN。デフォルト値は""です。
bindPasswd	オプション。リモート・ホストとの通信に使用されるプロキシのBindPasswd。デフォルト値は""です。
passCred	オプション。libOVD構成によってバックエンド(リモート・ホスト) LDAPサーバーに渡される資格証明がある場合は、それを制御します。指定可能な値は、Always(デフォルト)、NoneまたはBindOnlyです。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.16.3 例

createLDAPAdapter("testLDAP", "dc=us,dc=oracle,dc=com", "myhost.example.com", 3060, "dc=uk,dc=oid", false, "cn=testuser", "welcome1", "Always", "myContext"

createLDAPAdapter(adapterName='ldap1', root='dc=com', host='myhost.example.com', port=5566, remoteBase='dc=oid')

4.10.17 createLDAPAdapterWithDefaultPlugins

新しいLDAPアダプタを作成します。

4.10.17.1 説明

OPSSコンテキストに関連付けられたlibOVD構成のディレクトリ・タイプに基づいて、デフォルトのプラグインで新しいLDAPアダプタを作成します。

4.10.17.2 構文

createLDAPAdapterWithDefaultPlugins(adapterName, directoryType, root, host, port, remoteBase, [isSecure], [bindDN], [bindPasswd], [contextName])

引数	定義
adapterName	作成するLDAPアダプタの名前。
directoryType	ディレクトリ・タイプ。指定できる値は、次のディレクトリのいずれかです。 OID - Oracle Internet Directory OUD - Oracle Unified Directory SUNONE- Sun Java System Directory Server OVD - Oracle Virtual Directory ACTIVE_DIRECTORY - Microsoft Active Directory EDIRECTORY - Novell eDirectory OPEN_LDAP - Open LDAP WLS_OVD - Oracle WebLogic Server OVD TIVOLI - IBM Tivoli Directory Server
root	LDAPアダプタの仮想ネームスペース。
host	LDAPアダプタの通信先となるリモートLDAPホスト。
port	リモート・ホストのポート。
remoteBase	ルートが対応するリモートDIT内の場所。
isSecure	オプション。trueに設定された場合、リモート・ホストへのセキュアなSSL/TLS接続を可能にするブール値。デフォルト値はfalseです。
bindDN	オプション。リモート・ホストとの通信に使用されるプロキシのBindDN。デフォルト値は""です。
bindPasswd	オプション。リモート・ホストとの通信に使用されるプロキシのBindPasswd。デフォルト値は""です。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.17.3 例

createLDAPAdapterWithDefaultPlugins("testLDAP", "OID", "dc=us,dc=oracle,dc=com", "myhost.example.domain.com", 3060, "dc=uk,dc=oid", false, "cn=testuser", "welcome1", "myContext")

createLDAPAdapterWithDefaultPlugins(adapterName='ldap1', directoryType="OID", root='dc=com', host='myhost.example.domain.com', port=5566, remoteBase='dc=oid',bindDN="cn=testuser",bindPasswd="welcome1",contextName='default')

4.10.18 createView

新しいビューを作成します。

4.10.18.1 説明

OPSSコンテキストに関連付けられたlibOVD構成の新しいビューを作成します。

4.10.18.2 構文

createView(viewName, [contextName])

引数	定義
viewName	新しいビューの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.18.3 例

createView('userView','default')

4.10.19 deleteAdapter

既存のアダプタを削除します。

4.10.19.1 説明

OPSSコンテキストに関連付けられたlibOVD構成の既存のアダプタを削除します。

4.10.19.2 構文

deleteAdapter(adapterName, [contextName])

引数	定義
adapterName	削除する結合アダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.19.3 例

deleteAdapter(adapterName='join1') 
deleteAdapter('join1', 'default')

4.10.20 deleteAttributeExclusionRule

属性除外ルールを削除します。

4.10.20.1 説明

OPSSコンテキストに関連付けられたlibOVD構成の属性除外ルールを削除します。

4.10.20.2 構文

deleteAttributeExclusionRule(attribute, mappingContextId, [contextName])

引数	定義
attribute	除外リストから削除する属性の名前。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.20.3 例

deleteAttributeExclusionRule('objectsid','userrole')

4.10.21 deleteAttributeRule

属性マッピング・ルールを削除します。

4.10.21.1 説明

OPSSコンテキストに関連付けられたlibOVD構成の属性マッピング・ルールを削除します。

4.10.21.2 構文

deleteAttributeRule(srcAttrs, dstAttr, mappingContextId, [contextName])

引数	定義
srcAttrs	ソース属性。
dstAttr	宛先属性。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.21.3 例

deleteAttributeRule('lastname','sn')

4.10.22 deleteDomainExclusionRule

ドメイン除外ルールを削除します。

4.10.22.1 説明

OPSSコンテキストに関連付けられたlibOVD構成のドメイン除外ルールを削除します。

4.10.22.2 構文

deleteDomainExclusionRule(domain, mappingContextId, [contextName])

引数	定義
domain	除外リストから削除するコンテナの識別名。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.22.3 例

deleteDomainExclusionRule('cn=group,dc=oracle,dc=com','userrole')

4.10.23 deleteDomainRule

ドメイン・マッピング・ルールを削除します。

4.10.23.1 説明

OPSSコンテキストに関連付けられたlibOVD構成のドメイン・マッピング・ルールを削除します。

4.10.23.2 構文

deleteDomainRule(srcDomain, destDomain, mappingContextId, [contextName])

引数	定義
srcDomain	ソース・ドメイン。
destDomain	宛先ドメイン。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.23.3 例

deleteDomainRule('dc=oracle,dc=com','dc=oracle,dc=com','userrole')

4.10.24 deleteMappingContext

マッピング・コンテキストを削除します。

4.10.24.1 説明

OPSSコンテキストに関連付けられたlibOVD構成の指定されたマッピング・コンテキストを削除します。

4.10.24.2 構文

deleteMappingContext(mappingContextId, [contextName])

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.24.3 例

deleteMappingContext('defaultContext','context)

4.10.25 deleteView

ビューを削除します。

4.10.25.1 説明

OPSSコンテキストに関連付けられたlibOVD構成のビューを削除します。

4.10.25.2 構文

createView(viewName, [contextName])

引数	定義
viewName	削除するビューの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.25.3 例

deleteView('userView','default')

4.10.26 getAdapterDetails

既存のアダプタの詳細を表示します。

4.10.26.1 説明

OPSSコンテキストに関連付けられたlibOVD構成用に構成されている既存のアダプタの詳細を表示します。

4.10.26.2 構文

getAdapterDetails(adapterName, [contextName])

引数	定義
adapterName	表示する詳細を含むアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.26.3 例

getAdapterDetails(adapterName='ldap1', contextName='default')

getAdapterDetails(adapterName='join1')

4.10.27 listAdapters

すべてのアダプタの名前とタイプを一覧表示します。

4.10.27.1 説明

OPSSコンテキストに関連付けられているlibOVD構成用に構成されているすべてのアダプタの名前とタイプを一覧表示します。

4.10.27.2 構文

listAdapters([contextName])

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.27.3 例

listAdapters()

listAdapters(contextName='myContext')

4.10.28 listAllMappingContextIds

すべてのマッピング・コンテキストを一覧表示します。

4.10.28.1 説明

指定されたOPSSコンテキストに関連付けられているマッピング・コンテキストを一覧表示します。

4.10.28.2 構文

listAllMappingContextIds([contextName])

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.28.3 例

listAllMappingContextIds('default')

4.10.29 listAttributeRules

すべての属性ルールを一覧表示します。

4.10.29.1 説明

SOURCE_ATTRIBUTE:DESTINATION_ATTRIBUTE:DIRECTIONという形式で、すべての属性ルールを一覧表示します。

4.10.29.2 構文

listAttributeRules(mappingContextId, [contextName])

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.29.3 例

listAttributeRules('defaultContext','default') 

4.10.30 listDomainRules

すべてのドメイン・ルールを一覧表示します。

4.10.30.1 説明

SOURCE_DOMAIN:DESTINATION_DOMAINという形式で、すべてのドメイン・ルールを一覧表示します。

4.10.30.2 構文

listDomainRules(mappingContextId, [contextName])

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.30.3 例

listDomainRules('defaultContext','default')

4.10.31 listViews

すべてのビューを一覧表示します。

4.10.31.1 説明

OPSSコンテキストに関連付けられたlibOVD構成のすべてのビューを一覧表示します。

4.10.31.2 構文

listViews([contextName])

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.31.3 例

listViews('default')

4.10.32 modifyLDAPAdapter

LDAPアダプタのパラメータを変更します。

4.10.32.1 説明

既存のLDAPアダプタで定義されている次のパラメータを変更します。

• リモート・ベース

• ルート

• セキュア

• BindDN

• BindPassword

• PassCredentials

• MaxPoolSize

• MaxPoolChecks

• MaxPoolWait

• InitialPoolSize

• PoolCleanupInterval

• MaxPoolConnectionIdleTime

• Active

• PingProtocol

• PingBindDN

• PingBindPassword

• PageSize

• HeartBeatInterval

• OperationTimeout

• SearchCountLimit

• Visible

• Critical

• InclusionFilter

• ExclusionFilter

• DNPattern

• RequestControlAllowServerSupported

4.10.32.2 構文

modifyLDAPAdapter(adapterName, attribute, value, [contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
attribute	変更する属性の名前
value	属性の新しい値。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.32.3 例

modifyLDAPAdapter(adapterName='ldap1', attribute='Root', value='dc=us, dc=oracle, dc=com', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='RemoteBase', value='dc=org', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PassCredentials', value='BindOnly', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='BindDN', value='cn=proxyuser,dc=com', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='BindPassword', value='testwelcome123', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Secure', value=true, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolSize', value=500, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolChecks', value=10, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolWait', value=120000, contextName='mydefault') [value is in milliseconds] 

modifyLDAPAdapter(adapterName='ldap1', attribute='InitialPoolSize', value=10, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PoolCleanupInterval', value=300, contextName='mydefault') [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolConnectionIdleTime', value=300, contextName='mydefault')  [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='Active', value=false, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingProtocol', value='LDAP', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingBindDN', value='cn=proxyuser', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingBindPassword', value='welcome1', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PageSize', value=500, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='HeartBeatInterval', value=120, contextName='mydefault') [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='OperationTimeout', value=120000, contextName='mydefault') [value is in milliseconds] 

modifyLDAPAdapter(adapterName='ldap1', attribute='SearchCountLimit', value=100, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Visible', value='Yes', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Critical', value='false', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='InclusionFilter', value='objectclass=inetorgperson#base', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='ExclusionFilter', value='uniquemember=*#base', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='DNPattern', value='(.*)cn=[a-z0-9]*$', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='RequestControlAllowServerSupported', value=false, contextName='mydefault')

4.10.33 modifySocketOptions

ソケット・オプションを変更します。

4.10.33.1 説明

既存のLDAPアダプタ構成のソケット・オプションを変更します。

4.10.33.2 構文

modifySocketOptions(adapterName, reuseAddress, keepAlive, tcpNoDelay, readTimeout, [contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
reuseAddress	reuseAddressの値。
keepAlive	keepAliveの値。
tcpNoDelay	tcpNoDelayの値。
readTimeout	readTimeoutの値(秒)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.33.3 例

modifySocketOptions(adapterName='ldap1', reuseAddress=true, keepAlive=true, tcpNoDelay=true, readTimeout=180000, contextName='default')

4.10.34 removeAllRequestControlExcludeList

リクエスト制御除外リストからすべてのコントロールを削除します。

4.10.34.1 説明

既存のLDAPアダプタ構成のリクエスト制御除外リストからすべてのコントロールを削除します。

4.10.34.2 構文

removeAllRequestControlExcludeList(adapterName, [contextName])

引数	定義
adapterName	更新するアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.34.3 例

removeAllRequestControlExcludeList(adapterName='ldap1', contextName='default')

4.10.35 removeAllRequestControlIncludeList

リクエスト制御対象リストからすべてのコントロールを削除します。

4.10.35.1 説明

既存のLDAPアダプタ構成のリクエスト制御対象リストからすべてのコントロールを削除します。

4.10.35.2 構文

removeAllRequestControlIncludeList(adapterName, [contextName])

引数	定義
adapterName	更新するアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.35.3 例

removeAllRequestControlIncludeList(adapterName='ldap1', contextName='default')

4.10.36 removeFromRequestControlExcludeList

リクエスト制御除外リストからコントロールを削除します。

4.10.36.1 説明

既存のLDAPアダプタ構成のリクエスト制御除外リストからコントロールを削除します。

4.10.36.2 構文

removeFromRequestControlExcludeList(adapterName, control, [contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
control	LDAPコントロール・オブジェクト識別子(OID)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.36.3 例

removeFromRequestControlExcludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

4.10.37 removeDNAttribute

DN属性リストから属性を削除します。

4.10.37.1 説明

OPSSコンテキストに関連付けられたlibOVD用に構成されている既存のアダプタのDN属性リストから属性を削除します。

4.10.37.2 構文

removeDNAttribute(adapterName attributeName, [contextName])

引数	定義
adapterName	更新するアダプタの名前。
attributeName	削除する新しいDN属性の名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.37.3 例

removeDNAttribute(adapterName='ldap1', attributeName='memberof', contextName='default')

4.10.38 removeFromRequestControlIncludeList

リクエスト制御対象リストからコントロールを削除します。

4.10.38.1 説明

既存のLDAPアダプタ構成のリクエスト制御対象リストからコントロールを削除します。

4.10.38.2 構文

removeFromRequestControlIncludeList(adapterName, control, [contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
control	LDAPコントロール・オブジェクト識別子(OID)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.38.3 例

removeFromRequestControlIncludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

4.10.39 removeJoinRule

結合アダプタから結合ルールを削除します。

4.10.39.1 説明

指定されたOPSSコンテキストに関連付けられているlibOVD構成用に構成されている結合アダプタから結合ルールを削除します。

4.10.39.2 構文

removeJoinRule(adapterName, secondary, [contextName])

引数	定義
adapterName	変更する結合アダプタの名前。
secondary	このセカンダリ・アダプタに対応する結合ルールが結合アダプタから削除されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.39.3 例

removeJoinRule('join1','secondaryldap1', 'default')

removeJoinRule(adapterName='join1', secondary='LDAP3')

4.10.40 removeLDAPHost

既存のLDAPアダプタからリモート・ホストを削除します。

4.10.40.1 説明

既存のLDAPアダプタからリモート・ホスト(host:port)を削除します。

4.10.40.2 構文

removeLDAPHost(adapterName, host, [contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
host	LDAPアダプタの通信先となるリモートLDAPホストの場所。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.40.3 例

removeLDAPHost(adapterName='ldap1', host='myhost.example.com')

removeLDAPHost('ldap1', 'myhost.example.com', 'myContext')

4.10.41 removePlugin

既存のアダプタからプラグインを削除します。

4.10.41.1 説明

既存のアダプタから、またはグローバル・レベルでプラグインを削除します。

4.10.41.2 構文

removePlugin(pluginName, [adapterName], [contextName])

引数	定義
pluginName	削除するプラグインの名前。
adapterName	オプション。変更するアダプタの名前。指定しない場合、グローバル・プラグインが削除されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.41.3 例

removePlugin(adapterName='ldap1', pluginName='VirtualAttr')

removePlugin(pluginName='VirtualAttr')

4.10.42 removePluginParam

構成済のアダプタ・レベル・プラグインから既存のパラメータを削除します。

4.10.42.1 説明

構成済のアダプタ・レベル・プラグインまたはグローバル・プラグインから既存のパラメータを削除します。このコマンドは、プラグインから特定のパラメータのすべての値を削除します。

4.10.42.2 構文

removePluginParam(pluginName, paramKey, [adapterName], [contextName])

引数	定義
pluginName	変更するプラグインの名前。
paramKey	削除するパラメータ。
adapterName	オプション。変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.42.3 例

removePluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKey='ReplaceAttribute')

removePluginParam(pluginName='VirtualAttr', paramKey='ReplaceAttribute')

4.10.43 replacePluginParam

プラグインの既存のパラメータ値を置換します。

4.10.43.1 説明

指定されたアダプタ・レベル・プラグインまたはグローバル・プラグインの既存のパラメータ値を置換します。

4.10.43.2 構文

replacePluginParam(pluginName, paramName, paramValues, [adapterName,][contextName])

引数	説明
pluginName	変更するプラグインの名前。
paramName	置換するパラメータの名前。
paramValues	パラメータの新しい値。新しい値が複数の場合、それぞれの新しいパラメータ値を"|"で区切ります。
adapterName	オプション。変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.43.3 例

replacePluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramName='ReplaceAttribute', paramValues='cn=%uid%')

replacePluginParam(adapterName='ldap1', pluginName='UserManagement', paramName='mapAttribute', paramValues='orclguid=objectGuid | uniquemember=member')

4.10.44 unassignViewFromAdapter

アダプタからビューを割当て解除します。

4.10.44.1 説明

LDAPアダプタ構成からビューを割当て解除します。

4.10.44.2 構文

unassignViewFromAdapter(viewName, adapterName, [contextName])

引数	定義
viewName	ビューの名前。
adapterName	LDAPアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.44.3 例

unassignViewFromAdapter('userView','ldap1', 'default')

4.10.45 listSSLStoreType

使用中のSSLストアのタイプをリストするオンライン・コマンド。

4.10.45.1 説明

このコマンドは、libOVDのために使用されるSSLストアのタイプ(JKSまたはKSS)をリストします。

4.10.45.2 構文

listSSLStoreType(contextName=[contextName])

引数	定義
contextName	libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.45.3 例

listSSLStoreType(contextName='default')

4.10.46 enableKSSForSSL

KSSをlibOVD用に有効化するオンライン・コマンド。

4.10.46.1 説明

このコマンドはKSSをSSL用に有効化し、JKSがその前に有効だった場合、無効にします。KSSの詳細は、『Oracle® Fusion Middleware Oracle Platform Security Servicesによるアプリケーションの保護』を参照してください。

4.10.46.2 構文

enableKSSForSSL(contextName=[contextName])

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.46.3 例

enableKSSForSSL(contextName='default')

4.10.47 enableJKSForSSL

JKSをlibOVD用に有効化するオンライン・コマンド。

4.10.47.1 説明

このコマンドはJKSをSSL用に有効化し、KSSがその前に有効だった場合、無効にします。コマンドは、libOVD adapters.jksファイルが存在すると想定します。

4.10.47.2 構文

enableJKSForSSL(contextName=[contextName])

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.47.3 例

enableJKSForSSL(contextName='default')

4.10.48 createKeyStoreAndEnableJKSForSSL

JKSをSSL用に有効化するオンライン・コマンド。

4.10.48.1 説明

このコマンドはJKSをSSL用に有効化し、KSSがその前に有効だった場合、無効にします。コマンドは、libOVD adapters.jksファイルを作成します。

4.10.48.2 構文

createKeyStoreAndEnableJKSForSSL(keystorePassword=[password], contextName=[contextName])

引数	定義
keystorePassword	libOVD adapters.jksファイルのパスワード。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.48.3 例

createKeyStoreAndEnableJKSForSSL(keystorePassword='welcome1', contextName='default')

4.10.49 importTrustedCertificateIntoSSLStore

信頼できる証明書をSSLストアにインポートするオンライン・コマンド。

4.10.49.1 説明

このコマンドは、提供された信頼できる証明書をSSLストアにインポートします。

4.10.49.2 構文

importTrustedCertificateIntoSSLStore(certificateFileName=[cert_file],aliasName=[aliasName],contextName=[contextName])

引数	定義
certificateFileName	証明書を含むファイル名。
aliasName	証明書の別名。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.49.3 例

importTrustedCertificateIntoSSLStore(certificateFileName='/tmp/cert.txt',aliasName='myCert1',contextName='default')

4.10.50 migrateAllTrustedCertificatesFromJKSToKSS

すべての信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行するオンライン・コマンド。

4.10.50.1 説明

このコマンドは、すべての信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行します。

4.10.50.2 構文

migrateAllTrustedCertificatesFromJKSToKSS(contextName=[contextName])

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.50.3 例

migrateAllTrustedCertificatesFromJKSToKSS(contextName='default')

4.10.51 migrateTrustedCertificatesFromJKSToKSS

指定の信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行するオンライン・コマンド。

4.10.51.1 説明

このコマンドは、指定の信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行します。

4.10.51.2 構文

migrateTrustedCertificatesFromJKSToKSS(aliasNames=[alias_names], contextName=[contextName])

引数	定義
aliasNames	移行する別名のカンマ区切りのリスト。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.51.3 例

migrateTrustedCertificatesFromJKSToKSS (aliasNames='alias1,alias2', contextName='default')

4.10.52 changeLDAPHostPort

既存のLDAPアダプタ構成内にある指定のLDAPホストとポートを、新しいホストとポートに変更するオンライン・コマンド。

4.10.52.1 説明

このコマンドは、既存のLDAPアダプタ構成内にある指定のLDAPホストとポートを、新しいホストとポートに変更します。

4.10.52.2 構文

changeLDAPHostPort(adapterName=[adapterName], oldHost=[oldHost], oldPort=[oldPort], newHost=[newHost], newPort=[newPort], contextName=[contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
oldHost	古いLDAPホスト。
oldPort	古いLDAPポート。
newHost	新しいLDAPホスト。
newPort	新しいLDAPポート。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.52.3 例

changeLDAPHostPort(adapterName='ldap1', oldHost='oldhost.example.domain.com', oldPort=389, newHost='newhost.example.domain.com', newPort=389)

4.10.53 removeLDAPHostPort

既存のLDAPアダプタ構成からリモート・ホストとポートを削除するオンライン・コマンド。

4.10.53.1 説明

このコマンドは、既存のLDAPアダプタ構成からリモート・ホストとポートを削除します。

4.10.53.2 構文

removeLDAPHostPort(adapterName=[adapterName], host=[host], port=[port], contextName=[contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
host	リモートLDAPホスト。
port	リモートLDAPポート。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.53.3 例

removeLDAPHostPort(adapterName='ldap1', host='myhost.example.domain.com', port=389)

4.10.54 setReadOnlyForLDAPHost

既存のLDAPアダプタ構成内の指定のホストとポートを読取り専用または書き込み可能に設定するオンライン・コマンド。

4.10.54.1 説明

このコマンドは、既存のLDAPアダプタ構成内の指定のホストとポートを読取り専用または書き込み可能に設定します。

4.10.54.2 構文

setReadOnlyForLDAPHost(adapterName=[adapterName], host=[host], port=[port], readOnly=[true/false], contextName=[contextName])

引数	定義
adapterName	変更するLDAPアダプタの名前。
host	LDAPホスト。
port	LDAPポート。
readOnly	値はtrueまたはfalseです。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

4.10.54.3 例

setReadOnlyForLDAPHost(adapterName='ldap1', host='myhost.example.domain.com', port=389, readOnly=true)

4.11 アイデンティティ・ディレクトリ・サービス・コマンド

表4-17に示されているWLSTコマンドを使用して、アイデンティティ・ディレクトリ・サービスのエンティティ属性、エンティティ定義、関係およびデフォルトの操作構成を管理します。

表4-17 WLSTアイデンティティ・ディレクトリ・サービス・コマンド

コマンド	用途	WLSTでの使用
activateIDSConfigChanges	アイデンティティ・ディレクトリ・サービス構成を再ロードします。	オンライン
addAttributeInEntityConfig	エンティティ構成に新しい属性を追加します。	オンライン
addAttributePropsInEntityConfig	エンティティ構成内の属性に新しいプロパティを追加します。	オンライン
addAttributeRefForEntity	指定されたエンティティに新しい属性を追加します。	オンライン
addAttrrefPropsInEntityConfig	エンティティ構成内の属性参照に新しいプロパティを追加します。	オンライン
addCommonPropertyForOperationConfig	指定された操作構成に新しいプロパティを追加します。	オンライン
addEntity	エンティティ構成に新しいエンティティを追加します。	オンライン
addEntityProps	エンティティ構成内のエンティティに新しいプロパティを追加します。	オンライン
addEntityRelation	エンティティ構成に新しいエンティティ関係を追加します。	オンライン
addIdentityDirectoryService	構成に新しいアイデンティティ・ディレクトリ・サービスを追加します。	オンライン
addOperationConfig	エンティティ構成に新しい操作構成を追加します。	オンライン
addPropertyForOperationConfig	指定された操作構成に新しいプロパティを追加します。	オンライン
deleteAttributeInEntityConfig	エンティティ構成から属性を削除します。	オンライン
deleteAttrrefPropsInEntityConfig	エンティティ構成内の属性参照プロパティを削除します。	オンライン
deleteEntity	エンティティ構成からエンティティを削除します。	オンライン
deleteEntityProps	エンティティ構成内のエンティティ・プロパティを削除します。	オンライン
deleteEntityRelation	指定されたエンティティ関係を削除します。	オンライン
deleteIdentityDirectoryService	構成内の指定されたアイデンティティ・ディレクトリ・サービスを削除します。	オンライン
deleteOperationConfig	エンティティ構成内の操作構成を削除します。	オンライン
listAllAttributeInEntityConfig	エンティティ構成内のすべての属性を一覧表示します。	オンライン
listAllEntityInEntityConfig	指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します。	オンライン
listAllIdentityDirectoryService	構成内のすべてのアイデンティティ・ディレクトリ・サービスを一覧表示します。	オンライン
removeAttributeRefForEntity	指定されたエンティティから属性を削除します。	オンライン
removeCommonPropertyForOperationConfig	指定された操作構成のプロパティを削除します。	オンライン
removePropertyForOperationConfig	指定された操作構成のプロパティを削除します。	オンライン
updateAttributeInEntityConfig	エンティティ構成内の属性を更新します。	オンライン
updateAttributePropsInEntityConfig	エンティティ構成内の属性プロパティを更新します。	オンライン
updateAttrrefPropsInEntityConfig	エンティティ構成内の属性参照プロパティを更新します。	オンライン
updateEntity	エンティティ構成内のエンティティのプロパティを更新します。	オンライン
updateEntityAttrs	エンティティ構成内のエンティティの属性を更新します。	オンライン
updateEntityProps	エンティティ構成内のエンティティ・プロパティを更新します。	オンライン
deleteAttributePropsInEntityConfig	エンティティ構成内の属性プロパティを削除します。	オンライン

4.11.1 activateIDSConfigChanges

アイデンティティ・ディレクトリ・サービス構成を再ロードします。

4.11.1.1 説明

このコマンドは、アイデンティティ・ディレクトリ・サービス構成を再ロードします。

4.11.1.2 構文

activateIDSConfigChanges()

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

4.11.1.3 例

activateIDSConfigChanges()

4.11.2 addAttributeInEntityConfig

エンティティ構成に新しい属性を追加します

4.11.2.1 説明

このコマンドは、エンティティ構成に新しい属性を追加します。

4.11.2.2 構文

addAttributeInEntityConfig(name, datatype, description, readOnly, pwdAttr, appName)

引数	定義
name	追加する属性の名前。
datatype	属性のタイプは、次のいずれかとして定義されます。 binary boolean datetime double integer rfc822name string x500name
description	追加する属性の説明。
readOnly	属性が読取り専用であるか、変更可能であるかを指定するフラグ。
pwdAttr	属性でパスワードが定義されるかどうかを指定するフラグ。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.2.3 例

addAttributeInEntityConfig('commonname','string','common name',false,false,'userrole')

4.11.3 addAttributePropsInEntityConfig

エンティティ構成内の属性に新しいプロパティを追加します。

4.11.3.1 説明

このコマンドは、エンティティ構成内の属性に新しいプロパティを追加します。

4.11.3.2 構文

addAttributePropsInEntityConfig(name, propNames, propVals, appName)

引数	定義
name	追加する属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。 プロパティ(propNamesおよびpropVals)は、使用されていないキー/値ペアです。アプリケーションでは、これらのプロパティの属性レベルに必要なメタデータを格納できます。アイデンティティ・ディレクトリ・サービスでは、これらのプロパティ名に対して検証を実行せず、内部でこれらのプロパティを解釈または使用しません。 しかし、構成属性に対してはスキーマ・チェックを実行し、構成名とその値を解釈します。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.3.3 例

addAttributePropsInEntityConfig('orgunit','labelname|multivalued','common name|true','userrole')

4.11.4 addAttributeRefForEntity

指定されたエンティティに新しい属性を追加します。

4.11.4.1 説明

このコマンドは、指定されたエンティティに新しい属性を追加します。

4.11.4.2 構文

addAttributeRefForEntity(name, attrRefName, attrRefFilter, attrRefDefaultFetch, appName)

引数	定義
name	属性の追加先となるエンティティの名前。
attrRefName	エンティティに追加する属性の名前。
attrRefFilter	属性で使用されるフィルタのタイプで、次のいずれかとして定義されます。 beginswith contains doesnotcontain dynamic endswith equals greaterequal greaterthan lessequal lessthan none notequals
attrRefDefaultFetch	属性がデフォルトでフェッチされるかどうかを指定するフラグ。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.4.3 例

addAttributeRefForEntity('User','givenname','none','true','userrole')

4.11.5 addAttrrefPropsInEntityConfig

エンティティ構成内の属性参照に新しいプロパティを追加します。

4.11.5.1 説明

このコマンドは、エンティティ構成内の属性参照に新しいプロパティを追加します。

4.11.5.2 構文

addAttrrefPropsInEntityConfig(entityName, attrName, propNames, propVals, appName)

引数	定義
entityName	エンティティの名前。
attrName	属性参照の名前。
propNames	"|"で区切られたプロパティ名のリスト。 プロパティ(propNamesおよびpropVals)は、使用されていないキー/値ペアです。アプリケーションでは、これらのプロパティの属性レベルに必要なメタデータを格納できます。アイデンティティ・ディレクトリ・サービスでは、これらのプロパティ名に対して検証を実行せず、内部でこれらのプロパティを解釈または使用しません。 しかし、構成属性に対してはスキーマ・チェックを実行し、構成名とその値を解釈します。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.5.3 例

addAttrrefPropsInEntityConfig('org', 'orgunit','labelname|multivalued','common name|true','userrole')

4.11.6 addCommonPropertyForOperationConfig

指定された操作構成に新しいプロパティを追加します。

4.11.6.1 説明

このコマンドは、指定された操作構成に新しいプロパティを追加します。

4.11.6.2 構文

addCommonPropertyForOperationConfig(entityName, propName, propValue, appName)

引数	定義
entityName	エンティティの名前。
propName	この操作構成に追加するプロパティの名前。
propValue	この操作構成に追加するプロパティの値。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.6.3 例

addCommonPropertyForOperationConfig('groupmember.attr', 'member', 'userrole')

4.11.7 addEntity

エンティティ構成に新しいエンティティを追加します。

4.11.7.1 説明

このコマンドは、エンティティ構成に新しいエンティティを追加します。

4.11.7.2 構文

addEntity(name, type, idAttr, create, modify, delete, search, attrRefNames, attrRefFilters, attrRefDefaultFetches, appName)

引数	定義
name	属性の追加先となるエンティティの名前。
type	エンティティに追加する属性の名前。
idAttr	追加するエンティティのアイデンティティ属性。
create	作成が許可されていることを指定するフラグ。
modify	変更が許可されていることを指定するフラグ。
delete	削除が許可されていることを指定するフラグ。
search	検索が許可されていることを指定するフラグ。
attrRefNames	属性名の配列。
attrRefFilters	フィルタ・タイプ値の配列で、次のいずれかとして定義されます。 beginswith contains doesnotcontain dynamic endswith equals greaterequal greaterthan lessequal lessthan none notequals
attrRefDefaultFetches	ブール文字列の配列(true、false)。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.7.3 例

addEntity('Group','group','commonname',true,true,true,true,'name|commonname','none|none','true|false','userrole')

4.11.8 addEntityProps

エンティティ構成内のエンティティに新しいプロパティを追加します。

4.11.8.1 説明

このコマンドは、エンティティ構成内のエンティティに新しいプロパティを追加します。

4.11.8.2 構文

addEntityProps(name, propNames, propVals, appName)

引数	定義
name	エンティティの名前。
propNames	"|"で区切られたプロパティ名のリスト。
propValues	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.8.3 例

addEntityProps('User','inclobjclasses|exclobjclasses','inetorgperson|orclidxperson','userrole')

4.11.9 addEntityRelation

エンティティ構成に新しいエンティティ関係を追加します。

4.11.9.1 説明

このコマンドは、エンティティ構成に新しいエンティティ関係を追加します。

4.11.9.2 構文

addEntityRelation(name, type, fromEntity, fromAttr, toEntity, toAttr, recursive, appName)

引数	定義
name	指定された属性のエンティティ間の関係の名前。
type	エンティティ関係のタイプ(ManyToMany、ManyToOne、OneToMany、OneToOne)。
fromEntity	関係元となるエンティティの名前。
fromAttr	関係元となる属性の名前。
toEntity	関係先となるエンティティの名前。
toAttr	関係先となる属性の名前。
recursive	エンティティ関係を再帰的として設定するフラグ。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.9.3 例

addEntityRelation('manager', 'ManyToOne', 'User', 'manager', 'User', 'principal', false, 'userrole')

4.11.10 addIdentityDirectoryService

アイデンティティ・ディレクトリ・サービス構成に新しいIdentityStoreServiceを追加します。

4.11.10.1 説明

このコマンドは、アイデンティティ・ディレクトリ・サービス構成に新しいIdentityStoreServiceを追加します。

4.11.10.2 構文

addIdentityDirectoryService(name, description, propNames, propValues)

引数	定義
name	追加するIdentityStoreServiceの名前。
description	IdentityStoreServiceの説明。
propNames	IdentityStoreService構成に追加するプロパティ名の配列。
propValues	IdentityStoreService構成に追加するプロパティ名に対して定義される値の配列。

4.11.10.3 例

addIdentityDirectoryService('userrole', 'user role', 'ovd.context|entity.config', 'default|userrole')

4.11.11 addOperationConfig

エンティティ構成に新しい操作構成を追加します。

4.11.11.1 説明

このコマンドは、エンティティ構成に新しい操作構成を追加します。

4.11.11.2 構文

addOperationConfig(entityName, propNames, propValues, appName)

引数	定義
entityName	操作構成の追加先となるエンティティの名前。
propNames	操作構成に追加するプロパティ名の配列。
propValues	操作構成に追加するプロパティのプロパティ値の配列。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.11.3 例

addOperationConfig('User', 'entity.searchbase', 'cn=users,dc=oracle,dc=com', 'userrole')

4.11.12 addPropertyForOperationConfig

指定された操作構成に新しいプロパティを追加します。

4.11.12.1 説明

このコマンドは、指定された操作構成に新しいプロパティを追加します。

4.11.12.2 構文

addPropertyForOperationConfig(entityName, propName, propValue, appName)

引数	定義
entityName	操作構成の追加先となるエンティティの名前。
propName	操作構成に追加するプロパティ名。
propValue	操作構成に追加するプロパティの値。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.12.3 例

addPropertyForOperationConfig('User','entity.searchbase', 'cn=users,dc=oracle,dc=com', 'userrole')

4.11.13 deleteAttributeInEntityConfig

エンティティ構成から属性を削除します。

4.11.13.1 説明

このコマンドは、エンティティ構成から属性を削除します。

4.11.13.2 構文

deleteAttributeInEntityConfig(name, appName)

引数	定義
name	削除する属性の名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.13.3 例

deleteAttributeInEntityConfig('commonname', 'userrole')

4.11.14 deleteAttributePropsInEntityConfig

エンティティ構成内の属性プロパティを削除します。

4.11.14.1 説明

このコマンドは、エンティティ構成内の属性プロパティを削除します。

4.11.14.2 構文

deleteAttributePropsInEntityConfig(name, propNames, appName)

引数	定義
name	属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.14.3 例

deleteAttributePropsInEntityConfig('orgunit','labelname|multivalued','userrole')

4.11.15 deleteAttrrefPropsInEntityConfig

エンティティ構成内の属性参照プロパティを削除します。

4.11.15.1 説明

このコマンドは、エンティティ構成内の属性参照プロパティを削除します。

4.11.15.2 構文

deleteAttrrefPropsInEntityConfig(entityName, attrName, propNames, appName)

引数	定義
entityName	エンティティの名前。
attrName	属性参照の名前。
propNames	削除するプロパティ名のリスト。複数のプロパティを削除する場合は、"|"で区切る必要があります。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.15.3 例

deleteAttrrefPropsInEntityConfig('org', 'orgunit','labelname|multivalued','userrole')

4.11.16 deleteEntity

エンティティ構成からエンティティを削除します。

4.11.16.1 説明

このコマンドは、エンティティ構成からエンティティを削除します。

4.11.16.2 構文

deleteEntity(name, appName)

引数	定義
name	削除するエンティティの名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.16.3 例

deleteEntity('User', 'userrole')

4.11.17 deleteEntityProps

エンティティ構成内のエンティティ・プロパティを削除します。

4.11.17.1 説明

このコマンドは、エンティティ構成内のエンティティ・プロパティを削除します。

4.11.17.2 構文

deleteEntityProps(name, propNames, appName)

引数	定義
name	エンティティの名前。
propNames	"|"で区切られたプロパティ名のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.17.3 例

deleteEntityProps('User','inclobjclasses|exclobjclasses','userrole')

4.11.18 deleteEntityRelation

指定されたエンティティ関係を削除します。

4.11.18.1 説明

このコマンドは、指定されたエンティティ関係を削除します。

4.11.18.2 構文

deleteEntityRelation(name, appName)

引数	定義
name	指定された属性のエンティティ間の関係の名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.18.3 例

deleteEntityRelation('manager', 'userrole')

4.11.19 deleteIdentityDirectoryService

アイデンティティ・ディレクトリ・サービス構成内の指定されたIdentityStoreServiceを削除します。

4.11.19.1 説明

このコマンドは、アイデンティティ・ディレクトリ・サービス構成内の指定されたIdentityStoreServiceを削除します。

4.11.19.2 構文

deleteIdentityDirectoryService(name)

引数	定義
name	削除するIdentityStoreService構成の名前。

4.11.19.3 例

deleteIdentityDirectoryService('ids1')

4.11.20 deleteOperationConfig

エンティティ構成内の操作構成を削除します。

4.11.20.1 説明

このコマンドは、エンティティ構成内の操作構成を削除します。

4.11.20.2 構文

deleteOperationConfig(entityName, appName)

引数	定義
entityName	操作構成の削除元となるエンティティの名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.20.3 例

deleteOperationConfig('User','userrole')

4.11.21 listAllAttributeInEntityConfig

エンティティ構成内のすべての属性を一覧表示します。

4.11.21.1 説明

このコマンドは、エンティティ構成内のすべての属性をリストします。

4.11.21.2 構文

listAllAttributeInEntityConfig(appName)

引数	定義
appName	属性のリストの取得元となるエンティティ構成を含むアイデンティティ・ディレクトリ・サービスの名前。

4.11.21.3 例

listAllAttributeInEntityConfig('userrole')

4.11.22 listAllEntityInEntityConfig

指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します。

4.11.22.1 説明

このコマンドは、指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します。

4.11.22.2 構文

listAllEntityInEntityConfig(appName)

引数	定義
appName	属性のリストの取得元となるエンティティ構成を含むアイデンティティ・ディレクトリ・サービスの名前。

4.11.22.3 例

listAllEntityInEntityConfig('userrole')

4.11.23 listAllIdentityDirectoryService

アイデンティティ・ディレクトリ・サービス構成内のすべてのIdentityStoreServiceを一覧表示します。

4.11.23.1 説明

このコマンドは、アイデンティティ・ディレクトリ・サービス構成内のすべてのIdentityStoreServiceをリストします。

4.11.23.2 構文

listAllIdentityDirectoryService()

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

4.11.23.3 例

listAllIdentityDirectoryService()

4.11.24 removeAttributeRefForEntity

指定されたエンティティから属性を削除します。

4.11.24.1 説明

このコマンドは、指定されたエンティティから属性を削除します。

4.11.24.2 構文

removeAttributeRefForEntity(name, attrRefName, appName)

引数	定義
name	属性の削除元となるエンティティの名前。
attrRefName	削除する属性の名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.24.3 例

removeAttributeRefForEntity('User','givenname','userrole')

4.11.25 removeCommonPropertyForOperationConfig

指定された操作構成のプロパティを削除します。

4.11.25.1 説明

このコマンドは、指定された操作構成のプロパティを削除します。

4.11.25.2 構文

removeCommonPropertyForOperationConfig(entityName, propName, appName)

引数	定義
entityName	エンティティの名前。
propName	この操作構成について削除するプロパティの名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.25.3 例

removeCommonPropertyForOperationConfig('groupmember.attr','userrole')

4.11.26 removePropertyForOperationConfig

指定された操作構成のプロパティを削除します。

4.11.26.1 説明

このコマンドは、指定された操作構成のプロパティを削除します。

4.11.26.2 構文

removePropertyForOperationConfig(entityName, propName, appName)

引数	定義
entityName	操作構成の追加先となるエンティティの名前。
propName	操作構成に追加するプロパティ名。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.26.3 例

removePropertyForOperationConfig('User','entity.searchbase','userrole')

4.11.27 updateAttributeInEntityConfig

エンティティ構成内の属性を更新します。

4.11.27.1 説明

このコマンドは、エンティティ構成内の属性を更新します。

4.11.27.2 構文

updateAttributeInEntityConfig(name, attrNames, attrVals, appName)

引数	定義
name	更新するエンティティ属性の名前。
attrNames	"|"で区切られた構成属性名のリスト。有効な構成属性名は次のとおりです。 dataType description readOnly pwdAttr attrInUse
attrVals	"|"で区切られた対応する属性値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.27.3 例

updateAttributeInEntityConfig('commonname','readOnly|pwdAttr|attrInUse','true|false|false','userrole')

4.11.28 updateAttributePropsInEntityConfig

エンティティ構成内の属性プロパティを更新します。

4.11.28.1 説明

このコマンドは、エンティティ構成内の属性プロパティを更新します。

4.11.28.2 構文

updateAttributePropsInEntityConfig(name, propNames, propVals, appName)

引数	定義
name	更新する属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.28.3 例

updateAttributePropsInEntityConfig('orgunit','multivalued','multivalued','userrole')

4.11.29 updateAttrrefPropsInEntityConfig

エンティティ構成内の属性参照プロパティを更新します。

4.11.29.1 説明

このコマンドは、エンティティ構成内の属性参照プロパティを更新します。

4.11.29.2 構文

updateAttrrefPropsInEntityConfig(entityName, attrName, propNames, propVals, appName)

引数	定義
entityName	エンティティの名前。
attrName	属性参照の名前。
propNames	"|"で区切られたプロパティ名のリスト。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.29.3 例

updateAttrrefPropsInEntityConfig('org', 'orgunit','multivalued','multivalued','userrole')

4.11.30 updateEntity

エンティティ構成内のエンティティのプロパティを更新します。

4.11.30.1 説明

このコマンドは、エンティティ構成内のエンティティのプロパティを更新します。

4.11.30.2 構文

updateEntity(name, type, idAttr, create, modify, delete, search, appName)

引数	定義
name	更新するエンティティの名前。
type	エンティティのタイプ。
idAttr	エンティティのアイデンティティ属性。
create	作成が許可されていることを指定するフラグ。
modify	変更が許可されていることを指定するフラグ。
delete	削除が許可されていることを指定するフラグ。
search	検索が許可されていることを指定するフラグ。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.30.3 例

updateEntity('Group','group','commonname',true,true,true,true,'userrole')

4.11.31 updateEntityAttrs

エンティティ属性の構成属性を更新します。

4.11.31.1 説明

このコマンドは、エンティティ属性の構成属性を更新します。

4.11.31.2 構文

updateEntityAttrs(name, attrNames, attrVals, appName)

引数	定義
name	エンティティ属性の名前。 エンティティ属性のプロパティを更新するには、「updateAttributePropsInEntityConfig」を参照してください。
attrNames	構成属性名のリスト。複数の構成属性を更新する場合は、"|"で区切る必要があります。有効な構成属性名は次のとおりです。 idAttr pwdAttr firstnameAttr lastnameAttr mailAttr displaynameAttr descriptionAttr challengeQnAttr challengeAnsAttr commonIdAttr.
attrVals	"|"で区切られた対応する構成属性値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.31.3 例

updateEntityAttrs('User','idAttr|firstnameAttr','uid|givenname','userrole')

4.11.32 updateEntityProps

エンティティ構成内のエンティティ・プロパティを更新します。

4.11.32.1 説明

このコマンドは、エンティティ構成内のエンティティ・プロパティを更新します。

4.11.32.2 構文

updateEntityProps(name, propNames, propVals, appName)

引数	定義
name	追加する属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.32.3 例

updateEntityProps('User','inclobjclasses|exclobjclasses','inetorgperson|orclidxperson','userrole')

4.11.33 deleteAttributePropsInEntityConfig

エンティティ構成内の属性プロパティを削除します。

4.11.33.1 説明

このコマンドは、エンティティ構成内の属性プロパティを削除します。

4.11.33.2 構文

deleteAttributePropsInEntityConfig(name, propNames, appName)

引数	定義
name	削除する属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

4.11.33.3 例

deleteAttributePropsInEntityConfig('orgunit','labelname|validvalues','userrole')