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

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

• WSLTコマンドの使用

• 監査設定コマンド

• SSL設定コマンド

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

• Oracle Access Management Access Managerコマンド

• Oracle Access Management Identity Federationコマンド

• Oracle Access Management Mobile and Socialコマンド

• Oracle Access Managementセキュリティ・トークン・サービス

• Oracleキーストア・サービス

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

• Oracle Virtual Directoryライブラリ(LibOVD)コマンド

Oracleプラットフォーム・セキュリティ・サービスの詳細は、『Oracle Fusion Middleware Securityガイド』を参照してください。

WSLTコマンドの使用

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

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

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

コマンド・カテゴリ	説明
監査設定コマンド	監査ポリシーおよび監査リポジトリ設定を表示し管理します
SSL設定コマンド	Oracle HTTPサーバー、Oracle WebCache、Oracleインターネット・ディレクトリおよびOracle仮想ディレクトリ・コンポーネントのウォレット、JKSキーストアおよびSSL設定を表示し管理します。
Oracle Access Management Identity Federationコマンド	Oracle Access Management Identity Federationの構成を表示し管理します
セキュリティ・コマンド	ドメインおよび資格証明ドメイン・ストアを管理し、ドメイン・ポリシー・ストアを移動します。
Oracle Access Management Access Managerコマンド	認可プロバイダ、IDアサーション・プロバイダ、SSOプロバイダなど、Access Manager関連コンポーネントを管理します。

監査設定コマンド

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

表4-2 WLST監査コマンド

コマンド	用途	WLSTでの使用
getNonJavaEEAuditMBeanName	Java EE以外のコンポーネントのmBean名を表示します。	オンライン
getAuditPolicy	監査ポリシー設定を表示します。	オンライン
setAuditPolicy	監査ポリシー設定を更新します。	オンライン
getAuditRepository	監査リポジトリ設定を表示します。	オンライン
setAuditRepository	監査リポジトリ設定を更新します。	オンライン
listAuditEvents	1つ またはすべてのコンポーネントの監査イベントを表示します。	オンライン
exportAuditConfig	コンポーネントの監査設定をエクスポートします。	オンライン
importAuditConfig	コンポーネントの監査設定をインポートします。	オンライン

詳細は、『Oracle Fusion Middleware Securityガイド』を参照してください。

getNonJavaEEAuditMBeanName

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

説明

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

構文

getNonJavaEEAuditMBeanName(instName, compName, compType, svrName)

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

例

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

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

getAuditPolicy

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

説明

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

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

構文

getAuditPolicy([mbeanName, componentType])

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

例

次のコマンドは、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')

setAuditPolicy

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

説明

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

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

構文

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に設定されているときは、このパラメータが必要です。

例

次の対話型コマンドは、監査ポリシーを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

getAuditRepository

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

説明

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

構文

getAuditRepository 

例

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

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

setAuditRepository

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

説明

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

構文

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

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

例

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

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

listAuditEvents

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

説明

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

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

構文

listAuditEvents([mbeanName],[componentType])

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

例

次のコマンドは、Oracleプラットフォーム・セキュリティ・サービス・コンポーネントの監査イベントを表示します。

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サーバーの監査イベントを表示します。

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
...

exportAuditConfig

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

説明

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

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

構文

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

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

例

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

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

importAuditConfig

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

説明

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

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

構文

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

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

例

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

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

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

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

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管理者ガイドを参照してください。

addCertificateRequest

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

説明

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

構文

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

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

例

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

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

addSelfSignedCertificate

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

説明

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

構文

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

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

例

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

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

changeKeyStorePassword

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

説明

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

構文

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

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

例

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

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

changeWalletPassword

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

説明

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

構文

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

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

例

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

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

configureSSL

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

説明

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

構文

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

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

例

次のコマンドは、リスナー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')

createKeyStore

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

説明

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

構文

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

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

例

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

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

createWallet

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle HTTPサーバー・インスタンス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', '')

deleteKeyStore

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

説明

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

構文

deleteKeyStore(instName, compName, compType, keystoreName)

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

例

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

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

deleteWallet

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

説明

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

構文

deleteWallet(instName, compName, compType, walletName)

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

例

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

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

exportKeyStore

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

説明

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

構文

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

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

例

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

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

exportKeyStoreObject

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

exportWallet

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

説明

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

構文

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

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

例

次のコマンドは、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')

exportWalletObject

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

説明

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

構文

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	エクスポートするウォレット・オブジェクトの識別された名前を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

generateKey

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

getKeyStoreObject

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

getSSL

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

説明

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

構文

getSSL(instName, compName, compType, listener)

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

例

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

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

getWalletObject

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

importKeyStore

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

説明

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

構文

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

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

例

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

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

importKeyStoreObject

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

importWallet

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

説明

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

構文

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

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

例

次のコマンドは、自動ログイン・ウォレット・ファイル/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')

importWalletObject

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

listKeyStoreObjects

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

listKeyStores

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

説明

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

構文

listKeyStores(instName, compName, compType)

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

例

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

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

listWalletObjects

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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')

listWallets

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

説明

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

構文

listWallets(instName, compName, compType)

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

例

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

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

removeKeyStoreObject

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

説明

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

構文

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

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

例

次のコマンドは、アプリケーション・サーバー・インスタンス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)

removeWalletObject

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

説明

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

構文

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

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

例

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

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

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

createAppRole

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

説明

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

構文

createAppRole(appStripe, appRoleName)

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

例

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

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

deleteAppRole

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

説明

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

構文

createAppRole(appStripe, appRoleName)

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

例

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

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

grantAppRole

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

説明

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

構文

grantAppRole(appStripe, appRoleName,principalClass, principalName)

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

例

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

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

revokeAppRole

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

説明

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

構文

revokeAppRole(appStripe, appRoleName, principalClass, principalName)

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

例

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

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

listAppRoles

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

説明

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

構文

listAppRoles(appStripe)

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

例

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

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

listAppRolesMembers

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

説明

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

構文

listAppRoleMembers(appStripe, appRoleName)

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

例

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

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

grantPermission

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

説明

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

構文

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

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

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

例

次の呼出しは、指定したデータでアプリケーションの新しいパーミッション(アプリケーション・ストライプ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")

revokePermission

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

説明

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

構文

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

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

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

例

次の呼出しは、指定したデータのアプリケーションパーミッション(アプリケーション・ストライプ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")

listPermissions

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

説明

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

構文

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

listPermissions([appStripe,] principalClass, principalName)

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

例

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

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

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

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

deleteAppPolicies

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

説明

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

構文

deleteAppPolicies(appStripe)

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

例

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

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

migrateSecurityStore

ID、アプリケーション特定ポリシー、システム・ポリシー、特定資格証明フォルダまたはすべての資格証明を移動するオフライン・コマンドを示します。

説明

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

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

構文

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

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

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つのコンテキストから移動に使用するソース・リポジトリおよび対象リポジトリの場所を決定します。

例

次の呼出しは、アプリケーション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セキュリティ・ガイドを参照してください。

listCred

ドメイン資格証明ストア内の資格証明の属性の値のリストを返すオンライン・コマンドを示します。

説明

指定したマップ名およびキー名のドメイン資格証明ストア内の資格証明の属性の値のリストを返します。このコマンドは、パスワード・タイプのみの資格証明にカプセル化されたデータを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listCred(map, key)

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

例

次の呼出しは、マップ名myMapおよびキー名myKeyの資格証明内のすべての情報(ユーザー名、パスワード、URL、ポートおよび説明)を返します。

wls:/mydomain/serverConfig> listCred(map="myMap", key="myKey")

updateCred

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

説明

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

構文

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

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

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

例

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

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

createCred

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

説明

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

構文

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

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

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

例

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

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

deleteCred

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

説明

指定したマップ名およびキー名の資格証明をドメイン資格証明ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteCred(map,key)

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

例

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

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

modifyBootStrapCredential

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

説明

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

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

構文

modifyBootStrapCredential(jpsConfigFile, username, password)

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

例

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

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

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

addBootStrapCredential

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

説明

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

構文

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

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

例

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

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

exportEncryptionKey

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

説明

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

構文

exportEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

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

例

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

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

importEncryptionKey

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

説明

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

構文

importEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

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

例

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

restoreEncryptionKey

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

説明

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

構文

restoreEncryptionKey(jpsConfigFile)

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

例

restoreEncryptionKey(jpsConfigFile="pathName")

reassociateSecurityStore

ポリシーおよび資格証明ストアをLDAPリポジトリに移動するオンライン・コマンドを示します。

説明

指定したドメイン内のポリシー・ストアおよび資格証明ストアの両方を対象LDAPサーバー・リポジトリに移動します。LDAPサーバーの使用可能な種類は、OIDまたはOVDのみです。このコマンドでは、複数のドメインで共有するポリシー・ストアをセットアップすることも可能です(下記のオプションの引数joinを参照してください)。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。

構文

reassociateSecurityStore(domain, admin, password, ldapurl, servertype, jpsroot [, join] [,keyFilePath, keyFilePassword])

引数	定義
domain	再関連付けが起こるドメイン名を指定します。
admin	LDAPサーバー上の管理者のユーザー名を指定します。フォーマットは、cn=usrNameです。
password	引数adminに対して指定したユーザーに関連付けられるパスワードを指定します。
ldapurl	LDAPサーバーのURIを指定します。デフォルト・ポートを使用している場合は、フォーマットがldap//:host:portであり、保護したLDAPポートを使用している場合は、フォーマットがldaps://host:portです。保護したポートは、特にこの機能に対して設定する必要があり、デフォルト(保護以外)ポートと異なります。
servertype	対象LDAPサーバーの種類を指定します。有効なタイプとしては、OIDまたはOVDのみがあります。
jpsroot	すべてのデータが移動されている対象LDAPリポジトリ内のルート・ノードを指定します。フォーマットは、cn=nodeNameです。
join	このドメインで、他のドメイン内で指定されているポリシー・ストアを共有するかどうかを指定します。オプション。別のドメイン内の既存のポリシー・ストアを共有する場合はtrueに設定します。それ以外の場合はfalseに設定します。指定しない場合、この値はデフォルトのfalseに設定されます。この引数を使用することにより、複数のWebLogicドメインで同じ論理ポリシー・ストアをポイントすることができるようになります。
keyFilePath	ewallet.p12の書込み先となるディレクトリを指定します。
keyFilePassword	ファイルewallet.p12の生成時に使用されたパスワードを指定します。

例

次の呼出しは、ドメイン・ポリシーおよび資格証明をLDAP Oracleインターネット・ディレクトリ・サーバーに再び関連付けます。

wls:/mydomain/serverConfig> reassociateSecurityStore(domain="myDomain", 
admin="cn=adminName", password="myPass",ldapurl="ldap://myhost.example.com:3060", 
servertype="OID", jpsroot="cn=testNode")

ある他のドメイン(myDomainとは異なるドメインで、たとえばotherDomain)が、myDomain内のポリシー・ストアを共有するようにしたいとしましょう。この場合、次のようにコマンドを呼び出します。

wls:/mydomain/serverConfig> reassociateSecurityStore(domain="otherDomain", 
admin="cn=adminName", password="myPass", ldapurl="ldap://myhost.example.com:3060", 
servertype="OID", jpsroot="cn=testNode", join="true")

upgradeSecurityStore

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

説明

リリース10.1.x 1で使用されたID、ポリシーおよび資格証明データをリリース11で使用可能なセキュリティ・データに移動します。このコマンドを別に呼び出して、各種類のデータが移動されます。エラーが発生した場合は、WLSTExceptionが返されます。

構文

構文は、更新されているデータのタイプによって異なります。

10.1.x XML IDデータを11 XML IDデータに更新するには、次の構文を使用します。

updateSecurityStore(type="xmlIdStore", jpsConfigFile, srcJaznDataFile, srcRealm, dst)

10.1.x XMLポリシー・データを11 XMLポリシー・データに更新するには、次の構文を使用します。

updateSecurityStore(type="xmlPolicyStore", jpsConfigFile, srcJaznDataFile, dst)

10.1.x OID LDAPベース・ポリシー・データを11 XMLポリシー・データに更新するには、次の構文を使用します。

updateSecurityStore(type="oidPolicyStore", jpsConfigFile, srcJaznDataFile, dst)

10.1.x XML資格証明データを11 XML資格証明データに更新するには、次の構文を使用します。

updateSecurityStore(type="xmlCredStore", jpsConfigFile, srcJaznDataFile, users,  dst)

引数	定義
type	更新されているセキュリティ・データの種類を指定します。有効な値は、xmlIdStore、xmlPolicyStore、oidPolicyStoreおよびxmlCredStoreのみです。
jpsConfigFile	コマンドが実行しているディレクトリに対して設定ファイルjps-config.xmlの場所を指定します。更新の対象ストアは、引数dstで指定したコンテキストから読み込まれます。
srcJaznDataFile	コマンドが実行しているディレクトリに対して10.1.x jaznデータ・ファイルの場所を指定します。指定したタイプは、xmlIdStore、xmlPolicyStoreまたはxmlCredStoreの場合、この引数を使用する必要があります。
srcJaznConfigFile	コマンドが実行しているディレクトリに対して10.1.x jazn設定ファイルの場所を指定します。指定したタイプは、oidPolicyStoreの場合、この引数を使用する必要があります。
srcRealm	IDを移動する必要があるレルムの名前を指定します。指定したタイプは、xmlIdStoreの場合、この引数を使用する必要があります。
users	realmName/userNameとしてフォーマットした各ユーザーのカンマ区切りのリストを指定します。指定したタイプは、xmlCredStoreの場合、この引数を使用する必要があります。
dst	宛先ストアが設定されている引数jpsConfigFileに渡されたファイル内のjpsContextの名前を指定します。オプション。指定しない場合、デフォルトは、引数jpsConfigFileに渡されたファイル内のデフォルト・コンテキストになります。

例

次の呼出しは、10.1.3ファイル・ベースIDを11ファイル・ベースIDストアに移動します。

wls:/mydomain/serverConfig> upgradeSecurityStore(type="xmlIdStore",  
jpsConfigFile="jps-config.xml", srcJaznDataFile="jazn-data.xml",
srcRealm="jazn.com")

次の呼出しは、10.1.3 OIDベース・ポリシー・ストアを11ファイル・ベース・ポリシー・ストアに移動します。

wls:/mydomain/serverConfig> upgradeSecurityStore(type="oidPolicyStore", 
jpsConfigFile="jps-config.xml", srcJaznDataFile="jazn-data.xml",
dst="destinationContext)

createResourceType

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

説明

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

構文

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

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

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

例

次の呼出しは、ストライプ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=";"])

getResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプをフェッチするオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリの関連パラメータを取得します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getResourceType(appStripe, resourceTypeName)

引数	定義
appStripe	リソース・タイプのフェッチ元となるアプリケーション・ストライプを指定します。
resourceTypeName	フェッチするリソース・タイプの名前を指定します。

例

次の呼出しは、ストライプmyApplicationからリソース・タイプmyResTypeをフェッチします。

wls:/mydomain/serverConfig> getResourceType(appStripe="myApplication", resourceTypeName="myResType")

deleteResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプを削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteResourceType(appStripe, resourceTypeName)

引数	定義
appStripe	リソース・タイプの削除元となるアプリケーション・ストライプを指定します。
resourceTypeName	削除するリソース・タイプの名前を指定します。

例

次の呼出しは、ストライプmyApplicationからリソース・タイプmyResTypeを削除します。

wls:/mydomain/serverConfig> deleteResourceType(appStripe="myApplication", resourceTypeName="myResType")

listAppStripes

ポリシー・ストア内のアプリケーション・ストライプを一覧表示するオンラインまたはオフライン・コマンド。

説明

このスクリプトは、オフライン・モードまたはオンライン・モードで実行できます。オフライン・モードで実行する場合は、構成ファイルを渡す必要があります。渡された構成ファイルのデフォルト・コンテキストで構成によって参照されるポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。デフォルトの構成には、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。オンライン・モードで実行する場合は、構成ファイルを渡さないでください。接続しているドメインのポリシー・ストア内のストライプが一覧表示されます。いずれのモードでも、正規表現が渡されると、その正規表現に一致する名前を持つアプリケーション・ストライプが一覧表示されます。それ以外の場合は、すべてのアプリケーション・ストライプが一覧表示されます。

データベース・ベースのストアへの再関連付け後にこのコマンドをオフライン・モードで使用する場合は、Oracle Fusion Middlewareセキュリティ・ガイドのデータベース・ベースのストアへの再関連付け後のlistAppStripesの実行に関する項の説明に従って、再関連付けで生成された構成ファイルを手動で編集する必要があります。

構文

listAppStripes([configFile="configFileName"] [, regularExpression="aRegExp"])

引数	定義
configFile	OPSS構成ファイルへのパスを指定します。オプション。指定した場合、スクリプトはオフラインで実行されます。指定された構成ファイルのデフォルト・コンテキストに、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。指定しない場合、スクリプトはオンラインで実行され、ポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。
regularExpression	正規表現を指定します。この正規表現に一致するストライプ名が戻されます。オプション。指定しない場合、すべての名前が一致します。サブストリングに一致させるには、文字*を使用します。

例

次の(オンライン)呼出しは、ポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes

次の(オフライン)呼出しは、指定された構成ファイルのデフォルト・コンテキストで参照されるポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(configFile=" 
/home/myFile/jps-config.xml")

次の(オンライン)呼出しは、接頭辞Appを含むアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(regularExpression="App*")

createResource

新しいリソースを作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内に、指定されたタイプのリソースを作成します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

構文

createResource(appStripe="appStripeName", name="resName", type="resTypeName" [,-displayName="dispName"] [,-description="descript"])

引数	定義
appStripe	リソースの作成対象のアプリケーション・ストライプを指定します。
name	作成するリソースの名前を指定します。
type	作成するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。
displayName	作成するリソースの表示名を指定します。オプション。
description	作成するリソースの説明を指定します。オプション。

例

次の呼出しは、ストライプmyApplication内にリソースmyResourceを作成します。

wls:/mydomain/serverConfig> createResource(appStripe="myApplication", name="myResource", type="myResType", displayName="myNewResource")

deleteResource

リソースを削除するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格からリソースおよびそのすべての参照を削除します。このコマンドは、カスケード削除を実行します。資格が1つのリソースのみを参照している場合は、その資格を削除し、それ以外の場合は、渡されたタイプのリソース・アクションを資格から削除します。

構文

deleteResource(appStripe="appStripeName", name="resName", type="resTypeName")

引数	定義
appStripe	リソースの削除対象のアプリケーション・ストライプを指定します。
name	削除するリソースの名前を指定します。
type	削除するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

例

次の呼出しは、ストライプmyApplication内のリソースmyResourceを削除します。

wls:/mydomain/serverConfig> deleteResource(appStripe="myApplication", name="myResource", type="myResType")

listResources

指定されたアプリケーション・ストライプ内のリソースを一覧表示するオンライン・コマンド。

説明

リソース・タイプを指定した場合、指定されたリソース・タイプのすべてのリソースが一覧表示されます。それ以外の場合は、すべてのタイプのすべてのリソースが一覧表示されます。

構文

listResources(appStripe="appStripeName" [,type="resTypeName"])

引数	定義
appStripe	リソースの一覧表示対象のアプリケーション・ストライプを指定します。
type	一覧表示するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

例

次の呼出しは、ストライプmyApplication内のタイプmyResTypeのリソースをすべて一覧表示します。

wls:/mydomain/serverConfig> listResources(appStripe="myApplication", type="myResType")

listResourceActions

資格のリソースとアクションを一覧表示するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格のリソースとアクションを一覧表示します。

構文

listResourceActions(appStripe="appStripeName", permSetName="entitlementName")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
permSetName	リソースとアクションを一覧表示する資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementのリソースとアクションを一覧表示します。

wls:/mydomain/serverConfig> listResourceActions(appStripe="myApplication", permSetName="myEntitlement")

createEntitlement

新しい資格を作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプに、1つのリソースとアクションのリストを持つ新しい資格を作成します。既存の資格にリソースを追加するにはaddResourceToEntitlementを使用し、既存の資格からリソースを削除するにはrevokeResourceFromEntitlementを使用します。

構文

createEntitlement(appStripe="appStripeName", name="entitlementName", resourceName="resName", actions="actionList" [,-displayName="dispName"] [,-description="descript"])

引数	定義
appStripe	資格の作成対象のアプリケーション・ストライプを指定します。
name	作成する資格の名前を指定します。
resourceName	作成する資格の1つのリソース・メンバーの名前を指定します。
actions	リソースresourceNameのアクションのカンマ区切りのリストを指定します。
displayName	作成するリソースの表示名を指定します。オプション。
description	作成する資格の説明を指定します。オプション。

例

次の呼出しは、ストライプmyApplication内にリソースmyResourceのみを持つ資格myEntitlementを作成します。

wls:/mydomain/serverConfig> createEntitlement(appStripe="myApplication", name="myEntitlement", resourceName="myResource", actions="read,write")

getEntitlement

資格を取得するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格の名前、表示名およびすべてのリソース(とそれらの資格)を戻します。

構文

getEntitlement(appStripe="appStripeName", name="entitlementName")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	アクセスする資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementの情報を戻します。

wls:/mydomain/serverConfig> getEntitlement(appStripe="myApplication", name="myEntitlement")

deleteEntitlement

資格を削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格を削除します。アプリケーション・ストライプ内の指定された資格へのすべての参照を削除することで、カスケード削除を実行します。

構文

deleteEntitlement(appStripe="appStripeName", name="entitlementName")

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
name	削除する資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementを削除します。

wls:/mydomain/serverConfig> deleteEntitlement(appStripe="myApplication", name="myEntitlement")

addResourceToEntitlement

指定されたアクションを持つリソースを資格に追加するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格に、指定されたアクションを持つリソースを追加します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

構文

addResourceToEntitlement(appStripe="appStripeName", name="entName", resourceName="resName",actions="actionList")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	変更する資格の名前を指定します。
resourceName	追加するリソースの名前を指定します。
resourceType	追加するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。
actions	追加されるリソースのアクションのカンマ区切りのリストを指定します。

例

次の呼出しは、アプリケーション・ストライプmyApplication内の資格myEntitlementにリソースmyResourceを追加します。

wls:/mydomain/serverConfig> addResourceToEntitlement(appStripe="myApplication", 
name="myEntitlement", resourceName="myResource", resourceType="myResType", 
actions="view,edit")

revokeResourceFromEntitlement

資格からリソースを削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格からリソースを削除します。

構文

revokeResourceFromEntitlement(appStripe="appStripeName", name="entName", resourceName="resName", resourceType="resTypeName", actions="actionList")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	変更する資格の名前を指定します。
resourceName	削除するリソースの名前を指定します。
resourceType	削除するリソースのタイプを指定します。
actions	削除するアクションのカンマ区切りのリストを指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementからリソースmyResourceを削除します。

wls:/mydomain/serverConfig> revokeResourceFromEntitlement(appStripe="myApplication", name="myEntitlement", 
resourceName="myResource", resourceType="myResType", actions="view,edit")

listEntitlements

アプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

説明

アプリケーション・ストライプ内のすべての資格を一覧表示します。リソース名およびリソース・タイプを指定した場合、指定されたリソース名に一致する、指定されたタイプのリソースを持つ資格が一覧表示されます。それ以外の場合は、アプリケーション・ストライプ内のすべての資格が一覧表示されます。

構文

listEntitlements(appStripe="appStripeName" [,resourceTypeName="resTypeName", resourceName="resName"])

引数	定義
appStripe	資格の一覧表示対象のアプリケーション・ストライプを指定します。
resourceTypeName	一覧表示するリソースのタイプの名前を指定します。オプション。
resourceName	一致させるリソースの名前を指定します。オプション。

例

次の呼出しは、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication")

次の呼出しは、リソース・タイプmyResType、およびリソース名がmyResNameに一致するリソースを含む、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication", resourceTypeName="myResType", resourceName="myResName") 

grantEntitlement

新しい資格を作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内に、指定されたプリンシパルを持つ新しい資格を作成します。

構文

grantEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数	定義
appStripe	資格の作成対象のアプリケーション・ストライプを指定します。
principalClass	プリンシパルに関連付けられているクラスを指定します。
principalName	資格が付与されるプリンシパルの名前を指定します。
permSetName	作成する資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内に資格myEntitlementを作成します。

wls:/mydomain/serverConfig> grantEntitlement(appStripe="myApplication", 
principalClass="oracle.security.jps.service.policystore.ApplicationRole", 
principalName="myPrincipalName", permSetName="myEntitlement")

revokeEntitlement

資格を削除するオンライン・コマンド。

説明

資格を削除し、指定されたアプリケーション・ストライプ内のプリンシパルからその資格を取り消します。

構文

revokeEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
principalClass	プリンシパルに関連付けられているクラスを指定します。
principalName	資格が取り消されるプリンシパルの名前を指定します。
permSetName	削除する資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementを削除します。

wls:/mydomain/serverConfig> revokeEntitlement(appStripe="myApplication", 
principalClass="oracle.security.jps.service.policystore.ApplicationRole", 
principalName="myPrincipalName", permSetName="myEntitlement")

listEntitlement

指定されたアプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

説明

プリンシパル名およびクラスを指定した場合、指定されたプリンシパルに一致する資格が一覧表示されます。それ以外の場合は、すべての資格が一覧表示されます。

構文

listEntitlement(appStripe="appStripeName" [, principalName="principalName", principalClass="principalClass"])

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
principalName	一致させるプリンシパルの名前を指定します。オプション。
principalClass	一致させるプリンシパルのクラスを指定します。オプション。

例

次の呼出しは、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlement(appStripe="myApplication")

listResourceTypes

リソース・タイプを一覧表示するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のすべてのリソース・タイプを一覧表示します。

構文

listResourceTypes(appStripe="appStripeName")

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

例

次の呼出しは、ストライプmyApplication内のすべてのリソース・タイプを一覧表示します。

wls:/mydomain/serverConfig> listEntitlement(appStripe="myApplication")

Oracle Access Management Access Managerコマンド

表4-5に示されているWLSTコマンドを使用して、認可プロバイダ、IDアサーション・プロバイダ、SSOプロバイダなど、Oracle Access Management Access Manager (Access Manager)関連コンポーネントの管理に加えて、メトリックおよびデプロイメント・トポロジの表示や、Access Managerサーバーとエージェントの構成の管理およびロガー設定の管理を行います。

表4-5 WLST Access Managerコマンド

コマンド	用途	WLSTでの使用
createUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を作成します。	オンライン オフライン
editUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を編集します。	オンライン オフライン
deleteUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を削除します。	オンライン オフライン
displayUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を表示します。	オンライン オフライン
createOAMServer	Access Managerサーバー構成のエントリを作成します。	オンライン オフライン
editOAMServer	Access Managerサーバー構成のエントリを編集します。	オンライン オフライン
deleteOAMServer	指定されたAccess Managerサーバー構成を削除します。	オンライン オフライン
displayOAMServer	Access Managerサーバー構成の詳細を表示します。	オンライン オフライン
configOAMLoginPagePref	Access Managerログイン・ページのユーザー・プリファレンスを構成します。
configRequestCacheType	SSOサーバー・リクエスト・キャッシュ・タイプを構成します。	オンライン
displayRequestCacheType	SSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。	オンライン オフライン
editOssoAgent	OSSOエージェント構成の詳細を編集します。	オンライン オフライン
deleteOssoAgent	指定されたOSSOエージェント構成を削除します。	オンライン オフライン
displayOssoAgent	OSSOエージェント構成の詳細を表示します。	オンライン オフライン
editWebgateAgent	10g Webゲート・エージェントの登録の詳細を編集します。	オンライン オフライン
deleteWebgateAgent	指定された10g Webゲート・エージェント構成を削除します。	オンライン オフライン
displayWebgateAgent	Webゲート・エージェント構成の詳細を表示します。	オンライン オフライン
exportPolicy	テスト(ソース)から中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。	オンライン
importPolicy	指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。	オンライン
importPolicyDelta	指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。	オンライン
migratePartnersToProd	ソースAccess Managerサーバーから指定されたターゲットAccess Managerサーバーにパートナを移行します。	オンライン
exportPartners	ソースから指定された中間Access ManagerファイルにAccess Managerパートナをエクスポートします。	オンライン
importPartners	指定された中間Access ManagerファイルからAccess Managerパートナをインポートします。	オンライン
displayTopology	デプロイ済のAccess Managerサーバーの詳細を一覧表示します。	オンライン オフライン
configureOAAMPartner	Access ManagerとOracle Adaptive Access Managerの基本的な統合を構成します。	オンライン
registerOIFDAPPartner	Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。	オンライン オフライン
registerOIFDAPPartnerIDPMode	IDPモードでIdentity Federationを登録します。
registerThirdPartyTAPPartner	任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。	オンライン
disableCoexistMode	共存モードを無効にします。	オンライン
enableOamAgentCoexist	Access Managerエージェントの共存モードを有効にします(10g Webゲートによって設定されたObssocookieを所有するために、Access Manager 11gサーバーを有効にします)。	オンライン
disableOamAgentCoexist	Access Managerエージェントの共存モードを無効にします(10g Webゲートによって設定されたObssocookieからAccess Manager 11gサーバーを無効にします)。	オンライン
editGITOValues	GITO構成パラメータを編集します。	オンライン
editWebgate11gAgent	11g Webゲートの登録を編集します。	オンライン オフライン
deleteWebgate11gAgent	11g Webゲート・エージェントの登録を削除します。	オンライン オフライン
displayWebgate11gAgent	11g Webゲート・エージェントの登録を表示します。	オンライン オフライン
displayOAMMetrics	Access Managerサーバーのメトリックを表示します。	オンライン オフライン
updateOIMHostPort (非推奨)	Access Managerとの統合時にOracle Identity Manager構成を更新します。	オンライン
configureOIM (非推奨)	Access Managerとの統合時にOracle Identity Manager固有のエージェントの登録を作成します。	オンライン
updateOSSOResponseCookieConfig	OSSOプロキシ・レスポンスCookie設定を更新します。	オンライン
deleteOSSOResponseCookieConfig	OSSOプロキシ・レスポンスCookie設定を削除します。	オンライン
configureAndCreateIdentityStore	アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。	オンライン
configAndCreateIdStoreUsingPropFile	ファイル内に定義されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。	オンライン
migrateArtifacts (deprecated)	指定されたアーティファクト・ファイルに基づいてアーティファクトを移行します。	オンライン
displaySimpleModeGlobalPassphrase	システム構成から簡易モードのグローバル・パスフレーズを平文で表示します。	オンライン
exportSelectedPartners	指定された中間Access Managerファイルに、選択されたAccess Managerパートナをエクスポートします。	オンライン
oamMigrate	OSSO、OAM10g、OpenSSOまたはAM 7.1からOAM11gにポリシー、認証ストアおよびユーザー・ストアを移行します。	オンライン
preSchemeUpgrade	preSchemeUpgrade操作を呼び出します。	オンライン
postSchemeUpgrade	postSchemeUpgrade操作を呼び出します。	オンライン
oamSetWhiteListMode	trueに設定すると、Access Managerサーバーは、WhiteListURLリスト内で指定されているURLにのみリダイレクトされます。	オンライン
oamWhiteListURLConfig	構成ファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。	オンライン
enableMultiDataCentreMode	マルチ・データ・センター・モードを有効にします。	オンライン
disableMultiDataCentreMode	マルチ・データ・センター・モードを無効にします。	オンライン
setMultiDataCentreClusterName	マルチ・データ・センター・クラスタ名を設定します。	オンライン
setMultiDataCentreLogoutURLs	マルチ・データ・センター・ログアウトURLを設定します。	オンライン
addPartnerForMultiDataCentre	マルチ・データ・センターのパートナを追加します。	オンライン
removePartnerForMultiDataCentre	マルチ・データ・センターからパートナを削除します。	オンライン

createUserIdentityStore

Access Managerシステム構成にアイデンティティ・ストア登録を作成します。

説明

Access Managerに登録する新しいユーザー・アイデンティティ・ストアのための、システム構成のエントリを作成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

createUserIdentityStore(name="<Name>", principal="<Principal>", 
credential="<Credential>", type="<Type>", userAttr="<userAttr>", 
ldapProvider="<ldapProvider>", userSearchBase="<userSearchBase>", 
ldapUrl="<ldapUrl>", isPrimary="<isPrimary>", isSystem="<isSystem>", 
userIDProvider="<userIDProvider>", roleSecAdmin="<roleSecAdmin>", 
roleSysMonitor="<roleSysMonitor>", roleAppAdmin="<roleAppAdmin>", 
roleSysManager="<roleSysManager>", roleSecAdminGroups="<roleSecAdminGroups>", 
roleSecAdminUsers="<roleSecAdminUsers>", groupSearchBase="<groupSearchBase>", 
supplementaryReturnAttributes="<supplementaryReturnAttributes>", 
domainHome="<domainHome>")

引数	定義
name	必須。作成するLDAPアイデンティティ・ストアの一意の名前を指定します。大文字と小文字の英字および数字のみを使用します。
principal	必須。作成するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。たとえば、cn=Adminです。
credential	必須。作成するLDAPアイデンティティ・ストアのプリンシパルのパスワードを指定します。
type	必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。このコマンドでは、値はLDAPになります。
userAttr	必須。作成するLDAPアイデンティティ・ストアのユーザー属性を指定します。
ldapProvider	必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。値は、ODSEE、AD、OID、OVD、SJS、OUDなどです。この値は、Access Manager管理コンソールを使用して新しいユーザー・アイデンティティ・ストアが作成されるときに定義され、ユーザー・アイデンティティ・ストア内のストア・タイプに一致します。
userSearchBase	必須。作成するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、cn=usersです。
groupSearchBase	必須。作成するLDAPアイデンティティ・ストア内の、グループ・データが格納されるノードを指定します。たとえば、cn=groupsです。
ldapUrl	必須。作成するLDAPアイデンティティ・ストアのサーバー・ホストのURL(ポート番号を含む)を指定します。たとえば、ldap://localhost:7001です。
isPrimary	オプション。作成するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
isSystem	オプション。作成するLDAPアイデンティティ・ストアがシステム・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
userIDProvider	オプション。アイデンティティ・ストアへの接続に使用される基礎となるインフラストラクチャを指定します。サポートされているタイプはOracleUserRoleAPIのみです。
roleSecAdminGroups	オプション。Access Managerコンソール管理者権限を持つ1つ以上のカンマ区切りのグループを指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。
roleSecAdminUsers	オプション。Access Managerコンソール管理者権限を持つ1人以上のカンマ区切りのユーザーを指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。
roleSecAdmin	オプション。作成するLDAPアイデンティティ・ストアのセキュリティ管理者を指定します。
roleSysMonitor	オプション。作成するLDAPアイデンティティ・ストアのシステム・モニターを指定します。
roleAppAdmin	オプション。作成するLDAPアイデンティティ・ストアのアプリケーション管理者を指定します。
roleSysManager	オプション。作成するLDAPアイデンティティ・ストアのシステム管理者を指定します。
supplementaryReturnAttributes	Userオブジェクトの一部として取得する必要のある属性のカンマ区切りのリストを指定します。例: ORCL_USR_ENC_FIRST_NAME,ORCL_USR_ENC_LAST_NAME,USR_USRNAME,ORCL_USR_CTY_CODE,ORCL_USR_LANG_CODE_S,ORCL_USR_JROLE_ID_S,ORCL_USR_IND_ID,ORCL_USR_COMP_REL_ID,ORCL_USR_ASCII_IND,ORCL_ORA_UCM_VER,ORCL_ORA_UCM_SRVC
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。

例

次の例では、Access Managerで使用するための新しいOracle Internet Directoryユーザー・アイデンティティ・ストア定義を登録します。

createUserIdentityStore(name="Name1", principal="Principal1", 
credential="Credential1", type="Type1", userAttr="userAttr1", 
ldapProvider="ldapProvider", userSearchBase="userSearchBase", ldapUrl="ldapUrl", 
isPrimary="isPrimary", isSystem="isSystem", userIDProvider="userIDProvider", 
roleSecAdmin="<roleSecAdmin>", roleSysMonitor="<roleSysMonitor>",  
roleAppAdmin="<roleAppAdmin>", roleSysManager="<roleSysManager>", 
roleSecAdminGroups="<roleSecAdminGroups>", 
roleSecAdminUsers="<roleSecAdminUsers>", groupSearchBase="groupSearchBase", 
supplementaryReturnAttributes="supplementaryReturnAttributes", 
domainHome="domainHome1")

editUserIdentityStore

Access Manager用の定義済のアイデンティティ・ストアの登録を変更するオンラインおよびオフライン・コマンド。

説明

Access Managerに登録されているユーザー・アイデンティティ・ストアの属性を1つ以上変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editUserIdentityStore(name="<Name>", [ principal="<Principal>", 
credential="<Credential>", type="<Type>", userAttr="<userAttr>", 
ldapProvider="<ldapProvider>", roleSecAdmin="<roleSecAdmin>", 
roleSysMonitor="<roleSysMonitor>", roleSysManager="<roleSysManager>" , 
roleAppAdmin="<roleAppAdmin>", roleSecAdminGroups="<roleSecAdminGroups>", 
roleSecAdminUsers="<roleSecAdminUsers>", userSearchBase="<userSearchBase>", 
ldapUrl="<ldapUrl>", isPrimary="<isPrimary>", isSystem="<isSystem>", 
userIDProvider="<userIDProvider>" , groupSearchBase="<groupSearchBase>", 
domainHome="<domainHome>", userFilterObjectClasses="<userFilterObjectClasses>",  
groupFilterObjectClasses="<groupFilterObjectClasses>", 
referralPolicy="<referralPolicy>", searchTimeLimit="<searchTimeLimit>",  
minConnections="<minConnections>", maxConnections="<maxConnections>", 
connectionWaitTimeout="<connectionWaitTimeout>",  
connectionRetryCount="<connectionRetryCount>", groupNameAttr="<groupNameAttr>", 
groupCacheEnabled="<groupCacheEnabled>", groupCacheSize="<groupCacheSize>", 
groupCacheTTL=<"groupCacheTTL>", 
supplementaryReturnAttributes="<supplementaryReturnAttributes>" ) 

引数	定義
name	必須。変更するLDAPアイデンティティ・ストアの一意の名前を指定します。大文字と小文字の英字および数字のみを使用します。
principal	変更するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。たとえば、cn=Adminです。
credential	変更するLDAPアイデンティティ・ストアのプリンシパル管理者の暗号化パスワードを指定します。
type	変更するベース・アイデンティティ・ストアのタイプを指定します。このコマンドでは、値はLDAPになります。
userAttr	必須。変更するLDAPアイデンティティ・ストアのユーザー属性を指定します。
ldapProvider	必須。登録するLDAPアイデンティティ・ストアのLDAPタイプを指定します。値は、ODSEE、AD、OID、OVD、SJS、OUDなどです。この値は、Access Manager管理コンソールを使用して新しいユーザー・アイデンティティ・ストアが作成されるときに定義され、ユーザー・アイデンティティ・ストア内のストア・タイプに一致します。
roleSecAdminGroups	オプション。Access Managerコンソール管理者権限を持つ1つ以上のカンマ区切りのグループを指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。
roleSecAdminUsers	オプション。Access Managerコンソール管理者権限を持つ1人以上のカンマ区切りのユーザーを指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。
roleSecAdmin	オプション。変更するLDAPアイデンティティ・ストアのセキュリティ管理者を指定します。
roleSysMonitor	オプション。変更するLDAPアイデンティティ・ストアのシステム・モニターを指定します。
roleAppAdmin	オプション。変更するLDAPアイデンティティ・ストアのアプリケーション管理者を指定します。
roleSysManager	オプション。変更するLDAPアイデンティティ・ストアのシステム管理者を指定します。
userSearchBase	必須。変更するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、cn=usersです。
groupSearchBase	必須。変更するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、cn=groupsです。
ldapUrl	必須。変更するLDAPアイデンティティ・ストアのサーバー・ホストのURL(ポート番号を含む)を指定します。たとえば、ldap://localhost:7001です。
isPrimary	オプション。変更するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
isSystem	オプション。変更するLDAPアイデンティティ・ストアがシステム・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
userIDProvider	オプション。アイデンティティ・ストアへの接続に使用される基礎となるインフラストラクチャを指定します。サポートされているタイプはOracleUserRoleAPIのみです。
supplementaryReturnAttributes	Userオブジェクトの一部として取得する必要のある属性のカンマ区切りのリストを指定します。例: ORCL_USR_ENC_FIRST_NAME,ORCL_USR_ENC_LAST_NAME,USR_USRNAME,ORCL_USR_CTY_CODE,ORCL_USR_LANG_CODE_S,ORCL_USR_JROLE_ID_S,ORCL_USR_IND_ID,ORCL_USR_COMP_REL_ID,ORCL_USR_ASCII_IND,ORCL_ORA_UCM_VER,ORCL_ORA_UCM_SRVC
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。
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グループ・キャッシュ内の各エントリの合計存続時間を指定します。

例

次の例では、登録されているアイデンティティ・ストアの検索ベースの値を変更します。

editUserIdentityStore(name="IdStore1", userSearchBase="cn=users", groupSearchBase="cn=groups")

deleteUserIdentityStore

Access Manager用の定義済のアイデンティティ・ストアの登録を削除するオンラインおよびオフライン・コマンド。

説明

アイデンティティ・ストアの登録を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteUserIdentityStore(name="<name>", domainHome="<domainHome>") 

引数	定義
name	必須。削除するLDAPアイデンティティ・ストアの登録の名前を指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたアイデンティティ・ストアの登録を削除します。

deleteUserIdentityStore(name="identity_store", domainHome="domainHome1")

displayUserIdentityStore

ユーザー・アイデンティティ・ストアの登録に関する情報を表示するオンラインおよびオフライン・コマンド。

説明

Access Managerに登録されているアイデンティティ・ストアに関する情報を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayUserIdentityStore(name="<name>", domainHome="<domainHome>") 

引数	定義
name	必須。表示するLDAPアイデンティティ・ストアの登録の名前を指定します。
domainhome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の呼出しは、ユーザー・アイデンティティ・ストアの登録の詳細を表示します。

displayUserIdentityStore(name="ID_store1", domainHome="domainHome1")

createOAMServer

システム構成内にAccess Managerサーバー・エントリを作成するオンラインおよびオフライン・コマンド。

説明

Access Managerサーバーの登録を作成します。詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでOAMプロキシ共有シークレットが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

createOAMServer(configurationProfile="<configurationProfile>", host="<host>",port="<port>", oamProxyPort="<0000>", oamProxyServerID="<oamProxyServerID>",siteName="<siteName>", domainHome="<domainHome>")

引数	定義
configurationProfile	必須。OAM Serverの構成プロファイルを指定します。プロファイルは、Access Manager管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。
host	必須。Access Managerサーバー・ホストの名前を指定します。
port	必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。
oamProxyPort	必須。Access Managerサーバー・ホストのプロキシ・ポートを指定します。
oamProxyServerID	必須。Access Managerサーバー・ホストのプロキシ・サーバーIDを指定します。Access Managerプロキシ名は、Access Manager管理コンソールのサーバー・インスタンスのAccess Managerプロキシサブタブの下に表示されます。
siteName	必須。インスタンスのsiteName/serverNameを指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リスニング・ポート15000でmy_hostの構成を作成します。Access Manager管理コンソール内のAccess Manager構成エントリは、oam_server1になります。Access Managerプロキシ・ポートは3004、Access Managerプロキシ・サーバーIDはoamProxyServerID1です。

createOAMServer(configurationProfile="oam_server1", host="my_host",
port="15000", oamProxyPort="3004", oamProxyServerID="oamProxyServerID1",
siteName="siteName1", domainHome="domainHome1")

editOAMServer

Access Managerサーバーの登録の詳細を変更するオンラインおよびオフライン・コマンド。

説明

指定された、Access Managerサーバーの登録のパラメータ値を変更します。詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでAccess Managerプロキシ共有シークレットなどが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editOAMServer(configurationProfile="<configurationProfile>", host="<host>",port="<port>", oamProxyPort="<0000>", oamProxyServerID="<oamProxyServerID>",siteName="<siteName>", domainHome="<domainHome>")

引数	定義
configurationProfile	必須。Access Managerサーバーの構成プロファイルを指定します。プロファイルは、Access Manager管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。
host	必須。Access Managerサーバー・ホストの名前を指定します。
port	必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。
oamProxyPort	必須。Access Managerサーバー・ホストのプロキシ・ポートを指定します。
oamProxyServerID	必須。Access Managerサーバー・ホストのプロキシ・サーバーIDを指定します。Access Managerプロキシ名は、Access Manager管理コンソールのサーバー・インスタンスのAccess Managerプロキシサブタブの下に表示されます。
siteName	必須。インスタンスのsiteName/serverNameを指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

任意のオプションの属性を使用して、現在の設定を変更できます。次の呼出しは、Access Managerプロキシ・サーバーIDを構成エントリoam_server1に追加します。

editOAMServer(configurationProfile="oam_server1", host="my_host",
port="15000", oamProxyPort="3004", oamProxyServerID="oamProxyServerID1",
siteName="siteName1", domainHome="domainHome1")

deleteOAMServer

指定されたAccess Managerサーバーの登録を削除するオンラインおよびオフライン・コマンド。

説明

指定されたAccess Managerサーバー構成を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOAMServer(host="<host>", port="<port>", domainHome="<domainHome>")

引数	定義
host	必須。Access Managerサーバー・ホストの名前を指定します。
port	必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リスニング・ポートが15000であるoam_server1Access Managerサーバーの登録を削除します。

deleteOAMServer(host="oam_server1", port="15000", domainHome="domainHome1")

displayOAMServer

指定されたAccess Managerサーバーの登録の詳細を表示するオンラインおよびオフライン・コマンド。

説明

指定されたAccess Managerサーバーの登録の詳細を表示します。この詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでAccess Managerプロキシ共有シークレットが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOAMServer(host="<host>", port="<port>", domainHome="<domainHome>")

引数	定義
host	必須。Access Managerサーバー・ホストの名前を指定します。
port	必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_host Access Managerサーバー固有のすべてのメトリックを一覧表示します。

displayOAMServer(host="my_host", port="15000", domainHome="domainHome1")

configOAMLoginPagePref

Access Managerログイン・ページのユーザー・プリファレンスを構成します。

説明

Access Managerログイン・ページのユーザー・プリファレンスを構成します。

構文

configOAMLoginPagePref(persistentCookie="true", persistentCookieLifetime=14, 
persistentCookieDomain="oracle.com", langPrefOrder="serverOverrideLangPref, 
oamPrefsCookie, browserAcceptLanguage, defaultLanguage", 
serverOverrideLanguage="en", defaultLanguage="en", 
applicationSupportedLocales="en,fr")

引数	定義
persistentCookie	必須。OAM_USER_PREFS Cookieが永続的であるか非永続的であるかを定義するブールです。trueまたはfalseに設定します。
persistentCookieLifetime	必須。永続的なOAM_USER_PREFS Cookieの存続期間を示します。
persistentCookieDomain	必須。OAM_LANG_PREF Cookieのドメインを定義します。
langPrefOrder	必須。言語の優先順位を決定します。構文と例としてフォーマットする必要があります。許容される値セットは、(serverOverrideLangPref,oamPrefsCookie,browserAcceptLanguage,defaultLanguage)です。 oamAppCookie、oamLocaleHeader、oamPrefsCookie、browserAcceptLanguage、serverOverrideLangPref
serverOverrideLanguage	Access Managerのサーバー側言語言語コードで定義し、OAM対応の言語から選択している必要があります。デフォルト値はenです。
defaultLanguage	デフォルト言語。
applicationSupportedLocales	リストに定義されているサポートされている言語。

例

configOAMLoginPagePref(persistentCookie="true", persistentCookieLifetime=14, 
persistentCookieDomain="oracle.com", langPrefOrder="serverOverrideLangPref, 
oamPrefsCookie, browserAcceptLanguage, defaultLanguage", 
serverOverrideLanguage="en", defaultLanguage="en", 
applicationSupportedLocales="en,fr")

configRequestCacheType

システム構成内にSSOサーバー・リクエスト・キャッシュ・タイプを定義するオンラインおよびオフライン・コマンド。

説明

システム構成内にSSOサーバー・リクエスト・キャッシュ・タイプを定義します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configRequestCacheType(type="<requestCacheType>", domainHome="<domainHome>") 

引数	定義
type	必須。リクエスト・キャッシュ・タイプを指定します。値としてBASICまたはCOOKIEを取ります。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リクエスト・キャッシュ・タイプをCookieとして定義します。

configRequestCacheType(type="COOKIE") 

displayRequestCacheType

指定されたドメインに対して定義されているSSOサーバー・リクエスト・キャッシュ・タイプを表示するオンラインおよびオフライン・コマンド。リクエスト・キャッシュ・タイプは、BASICまたはCOOKIEです。

説明

指定されたドメインに対して定義されているSSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayRequestCacheType(domainHome="<domainHome>")

引数	定義
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン・ホームに対して定義されているリクエスト・キャッシュ・タイプ(BASICまたはCOOKIE)を表示します。

displayRequestCacheType(domainHome="domainHome1") 

editOssoAgent

システム構成内のOpenSSO (OSSO)エージェントの登録の詳細を変更するオンラインおよびオフライン・コマンド。

説明

サイト・トークン、成功URL、失敗URL、ホームURL、ログアウトURL、開始日、終了日、管理者ID、管理者情報など、OSSOエージェントの登録の詳細を変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editOssoAgent(agentName="AgentName", partnerId = "<partnerId>", 
siteToken = "<siteToken>", siteName = "<siteName>", successUrl ="<successUrl>", 
failureUrl = "<failureUrl>", homeUrl="<homeUrl>", logoutUrl="<logoutUrl>", startDate = "<startDate>", endDate = "<endDate>", adminId = "<adminId>", 
adminInfo = "<AdminInfo>", domainHome="<domainHomeName>") 

引数	定義
agentName	必須。変更するOSSOエージェント・エントリの名前を指定します。 adminIdは、OSSOエージェントの管理者IDです(オプション)。 adminInfoは、OSSOエージェントの管理者情報です(オプション)。
partnerId	オプション。OSSOエージェント・インスタンスのエージェント名を指定します。
siteToken	オプション。認証の要求時にパートナが使用するアプリケーション・トークンを指定します。
siteName	オプション。OSSOエージェント・インスタンスのSiteName/ServerNameを指定します。
successUrl	オプション。認証が成功した場合に、OSSOエージェントが使用するリダイレクトURLを指定します。
failureUrl	オプション。認証が失敗した場合に、OSSOエージェントが使用するリダイレクトURLを指定します。
homeUrl	オプション。認証後、ホーム・ページで使用するリダイレクトURLを指定します。
logoutUrl	オプション。ユーザーがログアウトしたときに使用するリダイレクトURLを指定します。
startDate	オプション。アプリケーションへのログインがサーバーによって許可される最初の年月日を指定します。
endDate	オプション。アプリケーションへのログインがサーバーによって許可される最後の年月日を指定します。
adminId	オプション。OSSOエージェントの管理者ログインIDを指定します。
adminInfo	オプション。トラッキング目的の、OSSOエージェントの管理者IDを指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1の登録エントリ内の管理者IDおよび情報を変更します。

editOssoAgent(agentName = "OSSOAgent1", partnerId = "partnerId", 
siteToken = "siteToken", siteName = "siteName", successUrl="successUrl", 
failureUrl = "failureUrl", homeUrl="homeUrl", logoutUrl="logoutUrl", 
startDate = "2009-12-10", endDate = "2012-12-30", adminId = "345", 
adminInfo = "Agent11", domainHome="domainHome1")

deleteOssoAgent

システム構成内の、指定されたOSSOエージェントの登録を削除するオンラインおよびオフライン・コマンド。

説明

システム構成内の、指定されたOSSOエージェントの登録を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOssoAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
agentName	必須。削除するOSSOエージェント・エントリの名前を指定します。
domainhome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1という名前のOSSOエージェントの登録エントリを削除します。

deleteOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")

displayOssoAgent

システム構成内の、指定されたOSSOエージェント・エントリの詳細を表示するオンラインおよびオフライン・コマンド。

説明

Access Manager管理コンソールに、指定されたOSSOエージェント・エントリの詳細を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOssoAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
agentName	必須。表示するOSSOエージェント・エントリの名前を指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1エントリの詳細を表示します。

displayOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")

editWebgateAgent

システム構成内の、Webゲート10gの登録エントリを変更するオンラインおよびオフライン・コマンド。

説明

システム構成内の、Webゲート10gの登録エントリを変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editWebgateAgent(agentName="<AgentName>",
accessClientPasswd="<accessClientPassword >",state="<state>", preferredHost="<host>", 
aaaTimeOutThreshold="<aaaTimeoutThreshold >", security="<security>",primaryCookieDomain="<primaryCookieDomain>", maxConnections="<maxConnections>",maxCacheElems="<maxCacheElements >", cacheTimeout="<cacheTimeOut>", 
cookieSessionTime="<cookieSessionTime >", maxSessionTime="<maxSessionTime>",
idleSessionTimeout="<idleSessionTimeout >",failoverThreshold="<failoverThreshold >", domainHome="<domainHomeName>")

引数	定義
agentName	必須。変更するWebゲート・エージェントの名前を指定します。
accessClientPasswd	オプション。Webゲート・エージェントのアクセス・クライアント・パスワードを指定します。
state	オプション。Webゲート・エージェントを有効にするか、無効にするかを指定します。値はそれぞれ、EnabledまたはDisabledです。
preferredHost	オプション。Webゲート・エージェントの優先ホストを指定します。これにより、ホストの識別子がホスト識別子リストに含まれていない場合に生じる可能性があるセキュリティ・ホールを防ぐことができます。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。
aaaTimeOutThreshold	オプション。Access Managerランタイム・サーバーからの応答を待機する秒数を指定します。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルト = -1(デフォルトのネットワークTCP/IPタイムアウトが使用されます)
security	オプション。Access Managerランタイム・サーバーに対するトランスポート・セキュリティのレベルを指定します。値としてopen、simpleまたはcertのいずれかを取ります。
primaryCookieDomain	オプション。Access Managerエージェントのデプロイ先のWebサーバー・ドメインを指定します。たとえば、acompany.comです。
maxConnections	オプション。このAccess ManagerエージェントがAccess Managerサーバーで確立できる接続の最大数を指定します。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルト = 1
maxCacheElems	オプション。キャッシュ内で維持される要素の最大数を指定します。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルト = 10000
cacheTimeout	オプション。キャッシュされた情報が使用も参照もされない場合に、その情報がAccess Managerエージェント・キャッシュ内にとどまる時間を指定します。デフォルトは1800(秒)です。
cookieSessionTime	オプション。ObSSOCookieが保持される時間を指定します。デフォルトは3600(秒)です。
maxSessionTime	オプション。ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)を指定します。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。値0を指定すると、このタイムアウト設定は無効になります。デフォルトは3600(秒)です。
idleSessionTimeout	ドメイン・ホームの場所を指定します。オフラインの場合、この値は必須です。オンラインの場合はオプションです。
failoverThreshold	オプション。このAccess ManagerエージェントがセカンダリAccess Managerサーバーへの接続をオープンするときのポイントを表す数を指定します。デフォルトは1です
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

任意の設定またはすべての設定を変更できます。次の例を使用して、エージェントID、状態、最大接続数、Access Managerサーバーのタイムアウト、プライマリCookieドメイン、キャッシュ・タイムアウト、Cookieセッション・タイムアウト、最大セッション・タイムアウト、アイドル・セッション・タイムアウトおよびフェイルオーバーしきい値を変更します。

editWebgateAgent(agentName="WebgateAgent1", accessClientPasswd="welcome1",
state="Enabled", preferredHost="141.144.168.148:2001", aaaTimeOutThreshold = "10",
security="open", primaryCookieDomain="primaryCookieDomain", maxConnections="16",
maxCacheElems="10000", cacheTimeout="1800", cookieSessionTime="3600",
maxSessionTime="24", idleSessionTimeout="3600", failoverThreshold="1", 
domainHome="domainHome1")

deleteWebgateAgent

システム構成内のWebgate_agent登録エントリを削除するオンラインおよびオフライン・コマンド。

説明

システム構成から指定されたWebgate_agent登録エントリを削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteWebgateAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
agentName	必須。削除するWebゲート・エージェントの名前を指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、WebgateAgent1という名前のWebゲート・エージェントを削除します。

deleteWebgateAgent(agentName="WebgateAgent1", domainHome="domainHome1")

displayWebgateAgent

Webgate_agent登録エントリを表示するオンラインおよびオフライン・コマンド。

説明

Access Manager管理コンソールに、指定されたWebgate_agent登録エントリのすべての詳細を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayWebgateAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
agentName	必須。表示するWebゲート・エージェントの名前を指定します。
domainhome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、WebgateAgent1のエントリの詳細を表示します。

displayWebgateAgent(agentName="WebgateAgent1", domainHome="domainHome1")

exportPolicy

テスト(ソース)環境から指定された中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートするオンラインのみのコマンド。

説明

テスト(ソース)環境から中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

exportPolicy(pathTempOAMPolicyFile="<absoluteFilePath>")

引数	定義
pathTempOAMPolicyFile	必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、テスト(ソース)環境からポリシー・データをエクスポートするときに使用するtempfile.txtファイルへのパスを指定します。

exportPolicy(pathTempOAMPolicyFile="/exampleroot/parent/tempfile.txt") 

importPolicy

指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPolicy(pathTempOAMPolicyFile="<absoluteFilePath>")

引数	定義
pathTempOAMPolicyFile	必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、ポリシー・データを本番(ターゲット)環境にインポートするときに使用するtempfile.txtファイルへのパスを指定します。

importPolicy(pathTempOAMPolicyFile="/exampleroot/parent/tempfile.txt") 

importPolicyDelta

指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPolicyDelta(pathTempOAMPolicyFile="<absoluteFilePath>")

引数	定義
pathTempOAMPolicyFile	必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、変更されたポリシー・データを本番(ターゲット)環境にインポートするときに使用するtempfile_delta.txtファイルへのパスを指定します。

importPolicyDelta(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_delta.txt") 

migratePartnersToProd

現在の(ソース)Access Managerサーバーから指定された(ターゲット)Access Managerサーバーにパートナを移行するオンラインのみのコマンド。

説明

現在の(ソース)Access Managerサーバーから指定された(ターゲット)Access Managerサーバーにパートナを移行します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

migratePartnersToProd(prodServerHost="<host>", prodServerPort="<port>", 
prodServerAdminUser="<user>", prodServerAdminPwd="<passwd>")

引数	定義
prodServerHost	パートナの移行先となるターゲットAccess Managerサーバーのホスト名。
prodServerPort	パートナの移行先となるターゲットAccess Managerサーバーのポート。
prodServerAdminUser	パートナの移行先となるターゲットAccess Managerサーバーの管理者。
prodServerAdminPwd	ターゲットAccess Managerサーバーの管理者のパスワード。

例

次の例では、パートナの移行に必要な情報を指定します。

migratePartnersToProd(prodServerHost="myhost", prodServerPort="1234", 
prodServerAdminUser="weblogic", prodServerAdminPwd="welcome")

exportPartners

ソースから指定されたAccess ManagerファイルにAccess Managerパートナをエクスポートするオンラインのみのコマンド。

説明

ソースから指定されたAccess ManagerファイルにAccess Managerパートナをエクスポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

exportPartners(pathTempOAMPartnerFile="<absoluteFilePath>")

引数	定義
pathTempOAMPolicyFile	必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、Access Managerパートナ・ファイルへの絶対パスを指定します。

exportPartners(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_partners.xml") 

importPartners

指定されたAccess ManagerファイルからAccess Managerパートナをインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerパートナをインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPartners(pathTempOAMPartnerFile="<absoluteFilePath>")

引数	定義
pathTempOAMPartnerFile	必須。一時Access Managerパートナ・ファイルへのパスを指定します。

例

次の例では、パートナのインポート元となるAccess Managerファイルへの絶対パスを指定します。

importPartners(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_partners.xml") 

displayTopology

デプロイメント内のすべてのAccess Managerサーバーに関する情報を表示するオンラインおよびオフライン・コマンド。

説明

デプロイ済のAccess Managerサーバーのトポロジを一覧表示します。

構文

displayTopology(domainHome="<domainHomeName>")

引数	定義
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン・ホーム内のデプロイ済のすべてのAccess Managerサーバーの詳細を一覧表示します。

displayTopology(domainHome="domainHome1")

configureOAAMPartner

Access ManagerとOracle Adaptive Access Manager (OAAM)の基本的な統合を構成するオンラインのみのコマンド。

説明

Access ManagerとOAAMの基本的な統合を構成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configureOAAMPartner(dataSourceName="<dataSourceName>", hostName="<hostName>", 
port="<port>", serviceName="<serviceName>", userName="<userName>", 
passWord="<passWord>", maxConnectionSize="<maxConnectionSize>", 
maxPoolSize="<maxPoolSize>", serverName="<serverName>")

引数	定義
dataSourceName	必須。作成するデータ・ソースの名前を指定します。
hostName	必須。データベース・ホストの名前を指定します。
port	必須。データベース・ポート番号を指定します。
serviceName	必須。データベース・サービス名を指定します。
userName	必須。OAAMスキーマ名を指定します。
passWord	必須。OAAMスキーマ・パスワードを指定します。
maxConnectionSize	オプション。接続予約タイムアウトの最大値を指定します。
maxPoolSize	オプション。接続プールの最大サイズを指定します。
serverName	オプション。データソースのターゲット・サーバーを指定します。

例

次の例では、Access ManagerとOAAMの基本的な統合を構成します。

configureOAAMPartner(dataSourceName="MyOAAMDS", hostName="host.example.com", 
port="1521", serviceName="sevice1", userName="username", passWord="password", 
maxConnectionSize=None, maxPoolSize=None, serverName="oam_server1")

registerOIFDAPPartner

Oracle Access Management Identity Federation (Identity Federation)をDelegated Authentication Protocol (DAP)パートナとして登録するオンラインおよびオフライン・コマンド。

説明

Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

registerOIFDAPPartner(keystoreLocation="/scratch/keystore" 
logoutURL="http://<oifhost>:<oifport>/fed/user/splooam11g?
 doneURL=http(s)://<oamhost>:<oamport>/oam/server/pages/logout.jsp", 
rolloverTime="nnn")

引数	定義
keystoreLocation	必須。キーストア・ファイル(Identity Federationサーバーで生成されたもの)の場所を指定します。
logoutURL	必須。Identity FederationサーバーのログアウトURLを指定します。
rolloverTime	オプション。SASSOトークンの暗号化/復号化に使用されたキーをロールオーバーできる時間(秒数)を指定します。

例

次の例では、パラメータの使用例を示します。

registerOIFDAPPartner(keystoreLocation="/scratch/keystore",
logoutURL="http(s)://oif.mycompany.com:1234/fed/user/splooam11g?
doneURL=http(s)://oam.mycompany.com:5678/oam/server/pages/logout.jsp", rolloverTime="500")

registerOIFDAPPartnerIDPMode

Identity FederationをDelegated Authentication Protocol (DAP)パートナとしてIDPモードで登録するオンラインおよびオフライン・コマンド。

説明

Identity FederationをDelegated Authentication Protocol (DAP)パートナとしてIDPモードで登録します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

registerOIFDAPPartnerIDPMode(logoutURL="http://<oifhost>:<oifport>/fed/user/sploosso?doneURL=http://<oamhost>:<oamport>/ngam/server/pages/logout.jsp")

引数	定義
logoutURL	必須。Identity FederationサーバーのログアウトURLを指定します。

例

次の例では、ログアウトURLパラメータの使用例を示します。

registerOIFDAPPartner(
logoutURL="http://oif.oracle.com:1234/fed/user/sploosso?
 doneURL=http://oam.oracle.com:5678/ngam/server/pages/logout.jsp")

registerThirdPartyTAPPartner

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

説明

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

構文

registerThirdPartyTAPPartner(partnerName="ThirdPartyTAPPartner", 
keystoreLocation="/scratch/DAPKeyStore/mykeystore.jks", 
password="test", tapTokenVersion="v2.0", tapScheme="TAPScheme", 
tapRedirectUrl="http://thirdpartyserverhost:port/loginPage.jsp")

引数	定義
partnerName	必須。パートナの名前を指定します。サード・パーティのパートナの識別に使用する任意の名前を指定できます。
keystoreLocation	必須。キーストア・ファイルの場所を指定します。
password	必須。キーストア・ファイルのパスワードを指定します。
tapTokenVersion	必須。Trusted Authentication Protocolのバージョンを指定します。
tapScheme	オプション。リソースの保護に使用するTAPScheme名を指定します(TAPSchemeは即時利用可能)。
tapRedirectUrl	オプション。資格証明コレクタのリダイレクト先となるTAPチャレンジURLを指定します。

例

次の例では、パラメータの使用例を示します。

registerThirdPartyTAPPartner(partnerName = "ThirdPartyTAPPartner", 
keystoreLocation="/scratch/DAPKeyStore/mykeystore.jks", 
password="test", tapTokenVersion="v2.0", tapScheme="TAPScheme", 
tapRedirectUrl="http://thirdpartyserverhost:port/loginPage.jsp")

disableCoexistMode

共存モードを無効にするオンライン・コマンド。

説明

共存モードを無効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

disableCoexistMode()

例

次の例では、共存モードを無効にします。

disableCoexistMode()

enableOamAgentCoexist

Access Managerエージェントの共存モードを有効にします(10g Webゲートによって設定されたObssocookieを所有するために、Access Manager 11gサーバーを有効にします)。

説明

Access Managerエージェントの共存モードを有効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

enableOamAgentCoexist()

例

次の例では、共存モードを有効にします。

enableOamAgentCoexist

disableOamAgentCoexist

Access Managerエージェントの共存モードを無効にします。

説明

Access Managerエージェントの共存モードを無効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

disableOamAgentCoexist()

例

次の呼出しは、共存モードを有効にします。

disableOamAgentCoexist

editGITOValues

GITO構成パラメータを編集するオンラインおよびオフライン・コマンド。

説明

GITO構成パラメータを編集します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editGITOValues(gitoEnabled="true", gitoCookieDomain=".abc.com", 
gitoCookieName="ABC", gitoVersion="v1.0", gitoTimeout="20", 
gitoSecureCookieEnabled="false", domainHome="/abc/def/ijk")

引数	定義
gitoEnabled	ユーザーによるGITO対応プロパティの設定を許可(または拒否)します。値としてtrueまたはfalseを取ります。
gitoCookieDomain	必須。GITO Cookieドメインを指定します。
gitoCookieName	オプション。Cookie名を指定します。
gitoVersion	オプション。GITOバージョンを指定します。値としてv1.0またはv3.0のみを取ります。
gitoTimeout	オプション。GITOタイムアウト値を指定します。
gitoSecureCookieEnabled	オプション。GITO Cookie対応プロパティを有効にします。値としてtrueまたはfalseを取ります。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、GITO構成パラメータを編集します。

editGITOValues(gitoEnabled="true", gitoCookieDomain=".abc.com", 
gitoCookieName="ABC", gitoVersion="v1.0", gitoTimeout="20", 
gitoSecureCookieEnabled="false", domainHome="/abc/def/ijk")

editWebgate11gAgent

システム構成内の11g Webgate_entry登録を編集するオンラインおよびオフライン・コマンド。

説明

システム構成内の11g Webgate_entry登録を編集します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editWebgate11gAgent(agentName="<AgentName>", 
accessClientPasswd="<accessClientPassword >",state="<state>", preferredHost="<host>", 
aaaTimeoutThreshold="<aaaTimeOutThreshold>", security="<security>",logOutUrls="<logOutUrls>", maxConnections="<maxConnections>",maxCacheElems="<maxCacheElements>", cacheTimeout="<cacheTimeOut>", 
logoutCallbackUrl="<logoutCallbackUrl >",maxSessionTime="<maxSessionTime>", logoutRedirectUrl="<logoutRedirectUrl >",failoverThreshold="<failoverThreshold>",
tokenValidityPeriod="<tokenValidityPeriod>",logoutTargetUrlParamName="<logoutTargetUrlParamName>", domainHome="<domainHome>",allowManagementOperations="<allowManagementOperations>", 
allowTokenScopeOperations="<allowTokenScopeOperations>", 
allowMasterTokenRetrieval="<allowMasterTokenRetrieval>", 
allowCredentialCollectorOperations="<allowCredentialCollectorOperations>")

引数	定義
agentName	必須。変更する11g Webゲート・エージェントの名前を指定します。
accessClientPasswd	オプション。このWebゲート・エージェントの一意のクライアント・パスワードを指定します。
state	オプション。Webゲート・エージェントを有効にするか、無効にするかを指定します。値はそれぞれ、EnabledまたはDisabledです。
preferredHost	オプション。Webゲート・エージェントの優先ホストを指定します。これにより、ホストの識別子がホスト識別子リストに含まれていない場合に生じる可能性があるセキュリティ・ホールを防ぐことができます。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。
aaaTimeoutThreshold	オプション。Access Managerランタイム・サーバーからの応答を待機する秒数を指定します。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルト = -1(デフォルトのネットワークTCP/IPタイムアウトが使用されます)
security	オプション。Access Managerランタイム・サーバーに対するトランスポート・セキュリティのレベルを指定します。値としてopen、simpleまたはcertのいずれかを取ります。
logOutUrls	ログアウト・ハンドラをトリガーするURLのリスト。ログアウト・ハンドラは、ObSSOCookieを削除します。
maxConnections	オプション。このAccess ManagerエージェントがAccess Managerサーバーで確立できる接続の最大数を指定します。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルト = 1
maxCacheElems	オプション。キャッシュ内で維持される要素の最大数を指定します。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルト = 10000
cacheTimeout	オプション。キャッシュされた情報が使用も参照もされない場合に、その情報がAccess Managerエージェント・キャッシュ内にとどまる時間を指定します。デフォルトは1800(秒)です。
logoutCallbackUrl	oam_logout_successへのURL。oam_logout_successは、コールバック中にCookieを消去します。デフォルトでは、これは、エージェントの登録時に指定されたエージェント・ベースURLに基づきます。例: http://<host>:<port>
maxSessionTime	オプション。ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)を指定します。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。値0を指定すると、このタイムアウト設定は無効になります。デフォルトは3600(秒)です。
logoutRedirectUrl	オプション。中央ログアウト・ページ(logout.html)へのURL(絶対パス)を指定します。デフォルトでは、これは、デフォルト・ポート14200のAccess Manager管理コンソールのホスト名に基づきます。
failoverThreshold	オプション。このAccess ManagerエージェントがセカンダリAccess Managerサーバーへの接続をオープンするときのポイントを表す数を指定します。デフォルト = 1
tokenValidityPeriod	オプション。Access Managerエージェントで保護されているリソースにアクセスすることなく、ユーザーの認証セッションが有効である時間(秒単位)を指定します。
logoutTargetUrlParamName	オプション。この値は、ログアウト時に呼び出され、OPSSレベルで構成されるログアウト・ターゲットURLです。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。
allowManagementOperations	オプション。管理操作の許可のフラグを設定します
allowTokenScopeOperations	オプション。トークン・スコープ操作の許可のフラグを設定します
idleSessionTimeout	オプション。次を指定します
allowMasterTokenRetrieval	マスター・トークン取得の許可のフラグを設定します
allowCredentialCollectorOperations	資格証明コレクタ操作の許可のフラグを設定します

例

次の例では、必須のパラメータとオプションのパラメータをすべて使用しています。

editWebgate11gAgent(agentName="WebgateAgent1", accessClientPasswd="welcome1",
state="Enabled", preferredHost="141.144.168.148:2001", aaaTimeoutThreshold="10",
security="open", logOutUrls="http://host1.oracle.com:1234", maxConnections = "16",
maxCacheElems="10000", cacheTimeout="1800", 
logoutCallbackUrl="http://host2.oracle.com:1234",
maxSessionTime="24", logoutRedirectUrl="logoutRedirectUrl", 
failoverThreshold="1", tokenValidityPeriod="tokenValidityPeriod",
logoutTargetUrlParamName="logoutTargetUrl", domainHome="domainHome1",
allowManagementOperations="false", allowTokenScopeOperations="false", 
allowMasterTokenRetrieval="false", allowCredentialCollectorOperations="false")

deleteWebgate11gAgent

システム構成内の11g Webgate_agentエントリを削除するオンラインおよびオフライン・コマンド。

説明

システム構成内の11g Webgate_agentエントリを削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteWebgate11gAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
agentName	必須。削除する11g Webゲート・エージェントの名前を指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_11gWebGateという名前の11g Webgate_agentエントリを削除します。

deleteWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")

displayWebgate11gAgent

11g Webgate_agent登録エントリを表示するオンラインおよびオフライン・コマンド。

説明

11g Webゲート・エージェント登録エントリを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayWebgate11gAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
agentName	必須。変更する11g Webゲート・エージェントの名前を指定します。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_11gWebGateという名前のWebゲート・エージェントを表示します。

displayWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")

displayOAMMetrics

Access Managerサーバーのメトリックを表示するオンラインおよびオフライン・コマンド。

説明

Access Managerサーバーのメトリックを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOAMMetrics(domainHome="<domainHomeName>")

引数	定義
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン内のAccess Managerサーバーのメトリックを表示します。

displayOAMMetrics(domainHome="domainHome1") 

updateOIMHostPort (非推奨)

非推奨 - Access Managerとの統合時にOracle Identity Manager構成を更新するオンラインのみのコマンド。

説明

システム構成内のIdentity Manager構成を更新します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

updateOIMHostPort(hostName="<host name>", port="<port number>", secureProtocol="true")

引数	定義
hostName	Identity Managerホストの名前。
port	Identity Managerホストのポート。
secureProtocol	通信がHTTP経由かHTTPS経由かに応じて、値としてtrueまたはfalseを取ります。

例

次の例では、このコマンドの使用例を示します。

updateOIMHostPort(hostName="OIM.oracle.com", port="7777", secureProtocol="true") 

configureOIM (非推奨)

非推奨 - Access Managerとの統合時にOracle Identity Manager固有のエージェント・プロファイルを登録するオンラインのみのコマンド。

説明

Access Managerとの統合時にOracle Identity Manager固有のエージェント・プロファイルを作成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configureOIM(oimHost="<OIM host>", oimPort="<port>", 
oimSecureProtocolEnabled="true | false", oimAccessGatePwd="<AccessGatePassword>", 
oimCookieDomain="<OIMCookieDomain>", oimWgId="<OIMWebgateID>", 
oimWgVersion="<OIMWebgateVersion>")

引数	定義
oimHost	Oracle Identity Managerホストの名前。EDGの場合は、OIMクラスタのフロント・エンドLBRホスト名。
oimPort	Oracle Identity Manager管理対象サーバーのポート。EDGの場合は、OIM管理対象サーバー・クラスタのフロント・エンドLBRポート。
oimSecureProtocolEnabled	通信がHTTP経由かHTTPS経由かに応じて、値としてtrueまたはfalseを取ります。
oimAccessGatePwd	指定する場合は、オープン・モードのエージェント・パスワード。
oimCookieDomain	Cookieが設定されるドメイン。
oimWgId	エージェントの登録名。
oimWgVersion	可能な値は10gまたは11gです。指定しない場合、デフォルトは10gです。

例

次の例では、このコマンドの使用例を示します。

configureOIM(oimHost="oracle.com", oimPort="7777", oimSecureProtocolEnabled="true",
oimAccessGatePwd = "welcome", oimCookieDomain = "domain1",
oimWgId="<OIM Webgate ID>", oimWgVersion="10g")

updateOSSOResponseCookieConfig

OSSOプロキシ・レスポンスCookie設定を更新するオンラインおよびオフライン・コマンド。

説明

OSSOプロキシ・レスポンスCookie設定を更新します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

updateOSSOResponseCookieConfig(cookieName="<cookieName>",cookieMaxAge="<cookie age in minutes>", isSecureCookie="true | false",cookieDomain="<domain of the cookie>", domainHome="<domainHomeName>")

引数	定義
cookieName	オプション。設定が更新されるCookieの名前。指定しない場合、グローバル設定が更新されます。
cookieMaxAge	Cookieの最大保持時間(分単位)。負の値の場合、セッションCookieが設定されます。
isSecureCookie	Cookieを保護する(SSLチャネルで送信する)かどうかを指定するブール・フラグ。
cookieDomain	Cookieのドメイン。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、このコマンドの使用例を示します。

updateOSSOResponseCookieConfig(cookieName = "ORASSO_AUTH_HINT",
cookieMaxAge = "525600", isSecureCookie = "false",
cookieDomain=".example.com", domainHome = "<domain_home>")

deleteOSSOResponseCookieConfig

システム構成内のOSSOプロキシ・レスポンスCookie設定を削除するオンラインおよびオフライン・コマンド。

説明

OSSOプロキシ・レスポンスCookie設定を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOSSOResponseCookieConfig(cookieName="<cookieName>", 
domainHome="<domainHomeName>")

引数	定義
cookieName	必須。設定が削除されるCookieの名前。グローバルCookie設定は削除できません。
domainHome	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、このコマンドの使用例を示します。

deleteOSSOResponseCookieConfig(cookieName="ORASSO_AUTH_HINT",
domainHome = "<domain_home>")

configureAndCreateIdentityStore

アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

説明

指定された値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

構文

configureOIM(oimHost="<OIM host>", oimPort="<port>", 
oimSecureProtocolEnabled="true | false", oimAccessGatePwd="<AccessGatePassword>", 
oimCookieDomain="<OIMCookieDomain>", oimWgId="<OIMWebgateID>", 
oimWgVersion="<OIMWebgateVersion>"), nameOfIdStore="<nameOfIdStore>", 
idStoreSecurityCredential="<idStoreSecurityCredential>",
userSearchBase="<userSearchBase>", ldapUrl="<ldapUrl>", 
groupSearchBase="<groupSearchBase>", securityPrincipal="<securityPrincipal>", idStoreType="<idStoreType>", ldapProvider="<ldapProvider>",
isPrimary="<isPrimary>", userIDProvider="<userIDProvider>", 
userNameAttr="<userNameAttr>"

引数	定義
oimHost	Oracle Identity Managerホストの名前。EDGの場合は、OIMクラスタのフロント・エンドLBRホスト名。
oimPort	Oracle Identity Manager管理対象サーバーのポート。EDGの場合は、OIM管理対象サーバー・クラスタのフロント・エンドLBRポート。
oimSecureProtocolEnabled	通信がHTTP経由かHTTPS経由かに応じて、値としてtrueまたはfalseを取ります。
oimAccessGatePwd	指定する場合は、オープン・モードのエージェント・パスワード。
oimCookieDomain	Cookieが設定されるドメイン。
oimWgId	エージェントの登録名。
oimWgVersion	可能な値は10gまたは11gです。指定しない場合、デフォルトは10gです。
nameOfIdStore	必須。作成するLDAPアイデンティティ・ストアの名前を指定します。
idStoreSecurityCredential	必須。作成するLDAPアイデンティティ・ストアのプリンシパルのパスワードを指定します。
userSearchBase	必須。作成するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。
ldapUrl	必須。作成するLDAPアイデンティティ・ストアのLDAPホストのURL(ポート番号を含みます)を指定します。
groupSearchBase	必須。作成するLDAPアイデンティティ・ストア内の、グループ・データが格納されるノードを指定します。
securityPrincipal	必須。作成するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。
idStoreType	必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。
ldapProvider	作成するストアのLDAPプロバイダ・タイプを指定します。
isPrimary	オプション。登録するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
userIDProvider	作成するストアのユーザー・アイデンティティ・プロバイダを指定します。
userNameAttr	必須。ストアのユーザー属性を指定します。

例

次の例では、このコマンドの使用例を示します。

configureOIM(oimHost="oracle.com", oimPort="7777", oimSecureProtocolEnabled="true",
oimAccessGatePwd = "welcome", oimCookieDomain = "domain1",
oimWgId="<OIM Webgate ID>", oimWgVersion="10g"
nameOfIdStore="nameOfIdStore", 
idStoreSecurityCredential="idStoreSecurityCredential", 
userSearchBase="userSearchBase", ldapUrl="ldapUrl", 
groupSearchBase="groupSearchBase", securityPrincipal="securityPrincipal", idStoreType="idStoreType", ldapProvider="ldapProvider", isPrimary="true", userIDProvider="userIDProvider", userNameAttr="userNameAttr")

configAndCreateIdStoreUsingPropFile

プロパティ・ファイル内に指定されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

説明

指定されたプロパティ・ファイル内に指定されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

構文

configAndCreateIdStoreUsingPropFile(path="<path_of_property_file>")

引数	定義
path	値が定義されているプロパティ・ファイルへのパス。

例

次の例では、このコマンドの使用例を示します。

configAndCreateIdStoreUsingPropFile(path="/prop_file_directory/values.properties")

migrateArtifacts(非推奨)

非推奨 - アーティファクトを移行します。

説明

入力アーティファクト・ファイル内に定義されている値に基づいてアーティファクトを移行します。

構文

migrateArtifacts(path="<path_to_artifacts_file>", password="<password>", 
type="OutOfPlace|InPlace", isIncremental="true|false")

引数	定義
path	アーティファクト・ファイルの場所
password	元のアーティファクトの生成時に使用されたパスワード。
type	移行のタイプを定義するブール値で、値としてInPlaceまたはOutOfPlaceを取ります
isIncremental	ブール値(値としてtrueまたはfalseを取ります)。trueの場合、増分アップグレードが実行されます。

例

次の例では、このコマンドの使用例を示します。

migrateArtifacts(path="/exampleroot/parent/t", password="welcome", 
type="InPlace", isIncremental="false")

displaySimpleModeGlobalPassphrase

システム構成内に定義されている簡易モードのグローバル・パスフレーズを平文で表示します。

説明

簡易モードのグローバル・パスフレーズを平文で表示するオンラインのみのコマンド。このコマンドには引数はありません。

構文

displaySimpleModeGlobalPassphrase()

例

次の例では、このコマンドの使用例を示します。

displaySimpleModeGlobalPassphrase()

exportSelectedPartners

指定されたAccess Managerファイルに、選択されたAccess Managerパートナをエクスポートします。

説明

指定されたAccess Managerファイルに、選択されたAccess Managerパートナをエクスポートします。

構文

exportSelectedPartners(pathTempOAMPartnerFile="<absoluteFilePath>", 
partnersNameList="<comma_separated_partner_names>")

引数	定義
pathTempOAMPartnerFile	必須。情報のエクスポート先となるファイルの場所。
partnersNameList	必須。エクスポートされるパートナIDのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

exportSelectedPartners(pathTempOAMPartnerFile="/exampleroot/parent/tempfile.extn"
partnersNameList="partner1,partner2")

oamMigrate

OSSO、OAM10g、OpenSSOまたはAM 7.1からOAM11gにポリシー、認証ストアおよびユーザー・ストアを移行するオンラインのみのコマンド。

説明

移行フレームワークMBeanのbeginMigrate操作を呼び出します。

構文

oamMigrate(oamMigrateType=<migrationType>, 
pathMigrationPropertiesFile="<absoluteFilePath>") 

引数	定義
oamMigrateType	必須。実行する移行のタイプを指定します。値として次のいずれかを取ります: OSSO | OpenSSO | OAM10g 注: OpenSSOはSAML 7.1とOpenSSOの両方に適用します。
pathMigrationPropertiesFile	必須。移行のために必要なアーティファクトの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

oamMigrate(oamMigrateType=OSSO,
pathMigrationPropertiesFile="/middlewarehome/oam-migrate.properties")

preSchemeUpgrade

preSchemeUpgrade操作を呼び出すオンラインのみのコマンド。

説明

preSchemeUpgrade操作を呼び出します。

構文

preSchemeUpgrade
(pathUpgradePropertiesFile="/middlewarehome/oam-upgrade.properties")

引数	定義
pathUpgradePropertiesFile	必須。アップグレードのために必要なシステム・プロパティの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

preSchemeUpgrade(pathUpgradePropertiesFile="/exampleroot/parent/tempfile.extn")

postSchemeUpgrade

postSchemeUpgrade操作を呼び出します。

説明

postSchemeUpgrade操作を呼び出します。

構文

postSchemeUpgrade
(pathUpgradePropertiesFile="/middlewarehome/oam-upgrade.properties")

引数	定義
pathUpgradePropertiesFile	必須。アップグレードのために必要なシステム・プロパティの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

postSchemeUpgrade(pathUpgradePropertiesFile="/exampleroot/parent/tempfile.extn")

oamSetWhiteListMode

oamSetWhiteListModeをtrueまたはfalseに設定します。

説明

oamSetWhiteListModeをtrueまたはfalseに設定します。trueの場合、Access Managerは、使用アプリケーションによって要求された最後のURLにリダイレクトされます(そのURLがホワイトリストURLとして構成されている場合のみ)。

構文

oamSetWhiteListMode(oamWhiteListMode="true|false")

引数	定義
oamWhiteListMode	必須。Access Managerのホワイトリスト・モードを有効にします。

例

次の例では、このコマンドの使用例を示します。

oamSetWhiteListMode(oamWhiteListMode="true")

oamWhiteListURLConfig

指定されたファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。

説明

指定されたファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。

構文

oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:1234", 
Operation="Remove|Update")

引数	定義
Name	必須。このエントリの名前(キー)を表す有効な文字列。
Value	必須。<protocol>://<host>:<port>という形式の有効なURL。ポートが指定されない場合、デフォルトのHTTP/HTTPSポートがそれぞれ割り当てられます。
Operation	必須。値としてUpdateまたはRemoveを取ります。大/小文字は区別されません。

例

次の例では、このコマンドの使用例を示します。

oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:1234", Operation="Update")

enableMultiDataCentreMode

マルチ・データ・センター・モードを有効にするオンラインのみのコマンド。

説明

マルチ・データ・センター・モードを有効にします。

構文

enableMultiDataCentreMode(propfile="<absoluteFilePath>")

引数	定義
propFile	必須。マルチ・データ・センターを有効にするためのプロパティの読取り元となるファイルへの絶対パスを指定します。

例

次の例では、このコマンドの使用例を示します。

enableMultiDataCentre(propfile="/middlewarehome/oamMDCProperty.properties")

disableMultiDataCentreMode

マルチ・データ・センター・モードを無効にするオンラインのみのコマンド。

説明

マルチ・データ・センター・モードを無効にします。このコマンドには、引数はありません。

構文

disableMultiDataCentreMode()

例

次の例では、このコマンドの使用例を示します。

disableMultiDataCentreMode()

setMultiDataCentreClusterName

マルチ・データ・クラスタ名を設定します。

説明

マルチ・データ・クラスタ名を設定します。

構文

setMultiDataCentreClusterName(clusterName="MyCluster")

引数	定義
clusterName	必須。クラスタの名前を指定します。

例

次の例では、このコマンドの使用例を示します。

postSchemeUpgrade(clusterName="MyCluster")

setMultiDataCentreLogoutURLs

マルチ・データ・パートナ・ログアウトURLを設定します。

説明

マルチ・データ・パートナ・ログアウトURLを設定します。

構文

setMultiDataCentreLogoutURLs
(logoutURLs="http://<host>:<port>/logout.jsp,http://<host>:<port>/logout.jsp")

引数	定義
logoutURLs	必須。マルチ・データ・センター・パートナ・ログアウトURLのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

setMultiDataCentreLogoutURLs(logoutURLs="http://localhost:6666/logout.jsp,http://localhost:8888/logout.jsp")

updateMultiDataCentreLogoutURLs

マルチ・データ・パートナ・ログアウトURLを更新します。

説明

マルチ・データ・パートナ・ログアウトURLを更新します。

構文

updateMultiDataCentreLogoutURLs
(logoutURLs="http://<host>:<port>/logout.jsp,http://<host>:<port>/logout.jsp")

引数	定義
logoutURLs	必須。マルチ・データ・センター・パートナ・ログアウトURLのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

updateMultiDataCentreLogoutURLs(logoutURLs="http://localhost:7777/logout.jsp,http://localhost:9999/logout.jsp")

addPartnerForMultiDataCentre

マルチ・データ・センターにパートナを追加するオンライン・コマンド。

説明

マルチ・データ・センターにパートナを追加します。このコマンドは、オンライン・モードでのみサポートされ、一度に1つのパートナを追加します。

構文

addPartnerForMultiDataCentre(propfile="<absoluteFilePath>")

引数	定義
propFile	必須。エージェント情報を含むファイルへの絶対パスを指定します。

例

次の例では、このコマンドの使用例を示します。

addPartnerForMultiDataCentre(propfile="/middlewarehome/partnerInfo.properties")

removePartnerForMultiDataCentre

マルチ・データ・センターからパートナを削除します。

説明

マルチ・データ・センターからパートナを削除します。このコマンドは、オンライン・モードでのみサポートされ、一度に1つのパートナを削除します。

構文

removePartnerForMultiDataCentre(webgateid="<webgateId")

引数	定義
webgateid	必須。削除するパートナのIDを指定します。

例

次の例では、このコマンドの使用例を示します。

removePartnerForMultiDataCentre(webgateid="IAMSuite")

Oracle Access Management Identity Federationコマンド

この項では、フェデレーション・パートナを構成するためのコマンドを示します。

表4-6 フェデレーション・パートナ用のWLST Access Managerコマンド

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

注意: この項のコマンド例には、キーと値の組合せ形式の属性で指定されるものとそうでないものがあります。Oracle Identity Federationはその両方をサポートしますが、キーと値の組合せ形式を使用する必要があります。

addOpenID20IdPFederationPartner

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

説明

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

構文

addOpenID20IdPFederationPartner(partnerName, idpSSOURL, discoveryURL, description) 

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

例

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

addOpenID20GoogleIdPFederationPartner()

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

説明

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

構文

addOpenID20GoogleIdPFederationPartner()

例

addOpenID20GoogleIdPFederationPartner()

addOpenID20YahooIdPFederationPartner()

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

説明

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

構文

addOpenID20YahooIdPFederationPartner()

例

addOpenID20YahooIdPFederationPartner()

addSAML11IdPFederationPartner

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

説明

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

構文

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

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

例

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

addSAML20IdPFederationPartner

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

説明

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

構文

addSAML20IdPFederationPartner(partnerName, metadataFile, description)

引数	定義
partnerName	作成するパートナの名前。
metadataFile	メタデータ・ファイルの場所(フルパス)。
description	パートナの説明。オプション。

例

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

addSAML20IdPFederationPartnerWithoutMetadata

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

説明

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

構文

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

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

例

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

configureIdPPartnerAttributeProfile

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

説明

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

構文

configureIdPPartnerAttributeProfile(attrProfileID, ignoreUnmappedAttributes)

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

例

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

configureSAML20Logout

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

説明

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

構文

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

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

例

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

configureSAMLBinding

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

説明

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

構文

configureSAMLBinding(partnerName, partnerType, binding)

引数	定義
partnerName	更新するパートナのID。
partnerType	パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを示します。 有効な値は、sp、idpです。
binding	使用するバインディング。 有効なオプションは、HTTP-POSTバインディングの場合はhttppost、HTTPリダイレクト/アーティファクト・バインディングの場合はhttpredirectです。

例

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

configureUserSelfRegistration

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

説明

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

構文

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

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

例

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

configureUserSelfRegistrationAttr

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

説明

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

構文

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

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

例

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

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

createAuthnSchemeAndModule

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

説明

OAM内のリソースを保護するためにOpenD IdPを使用する認証スキームを作成します。

構文

createAuthnSchemeAndModule(partnerName)

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

例

createAuthnSchemeAndModule("testpartner")

createIdPPartnerAttributeProfile

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

説明

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

構文

createIdPPartnerAttributeProfile(attrProfileID)

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

例

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

deleteAuthnSchemeAndModule

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

説明

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

構文

deleteAuthnSchemeAndModule(partnerName)

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

例

deleteAuthnSchemeAndModule("testpartner")

deleteFederationPartner

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

説明

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

構文

deleteFederationPartner(partnerName, partnerType)

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

例

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

deleteFederationPartnerEncryptionCert

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

説明

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

構文

deleteFederationPartnerEncryptionCert(partnerName, partnerType)

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

例

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

deleteFederationPartnerSigningCert

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

説明

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

構文

deleteFederationPartnerSigningCert(partnerName, partnerType)

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

例

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

deleteIdPPartnerAttributeProfile

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

説明

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

構文

deleteIdPPartnerAttributeProfile(attrProfileID)

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

例

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

deleteIdPPartnerAttributeProfileEntry

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

説明

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

構文

deleteIdPPartnerAttributeProfileEntry(attrProfileID,
messageAttributeName)

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

例

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

deletePartnerProperty

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

説明

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

構文

deletePartnerProperty(partnerName,partnerType,propName)

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

例

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

displayIdPPartnerAttributeProfile

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

説明

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

構文

displayIdPPartnerAttributeProfile(attrProfileID)

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

例

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

getAllFederationIdentityProviders

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

説明

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

構文

getAllFederationIdentityProviders()

例

getAllFederationIdentityProviders()

getFederationPartnerEncryptionCert

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

説明

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

構文

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

例

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

getFederationPartnerSigningCert

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

説明

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

構文

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

例

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

getIdPPartnerBasicAuthCredentialUsername

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

説明

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

構文

getIdPPartnerBasicAuthCredentialUsername(partnerName)

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

例

getIdPPartnerBasicAuthCredentialUsername(partnerName="partnerID5")

getPartnerProperty

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

説明

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

構文

getPartnerProperty(partnerName,partnerType,propName)

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

例

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

isFederationPartnerPresent

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

説明

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

構文

isFederationPartnerPresent(partnerName, partnerType)

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

例

isFederationPartnerPresent(partnerABC, SP)

listIdPPartnerAttributeProfileIDs

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

説明

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

構文

listIdPPartnerAttributeProfileIDs()

例

listIdPPartnerAttributeProfileIDs()

setDefaultSSOIdPPartner

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

説明

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

構文

setDefaultSSOIdPPartner(partnerName)

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

例

setDefaultSSOIdPPartner(partnerName="partner25")

setFederationPartnerEncryptionCert

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

説明

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

構文

setFederationPartnerEncryptionCert(partnerName,partnerType,certFile)

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

例

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

setFederationPartnerSigningCert

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

説明

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

構文

setFederationPartnerSigningCert(partnerName,partnerType,certFile)

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

例

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

setIdPPartnerAttributeProfile

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

説明

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

構文

setIdPPartnerAttributeProfile(partnerName, attrProfileID)

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

例

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

setIdPPartnerAttributeProfileEntry

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

説明

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

構文

setIdPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName,
oamSessionAttributeName, requestFromIdP)

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

例

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

setIdPPartnerBasicAuthCredential

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

説明

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

構文

setIdPPartnerBasicAuthCredential(partnerName,username,password)

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

例

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

setIdPPartnerMappingAttribute

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

説明

フェデレーション・パートナのアサーション・マッピングに使用される属性を設定します。

構文

setIdPPartnerMappingAttribute(partnerName,assertionAttr,userstoreAttr)

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

例

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

setIdPPartnerMappingAttributeQuery

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

説明

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

構文

setIdPPartnerMappingAttributeQuery(partnerName,attrQuery)

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

例

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

setIdPPartnerMappingNameID

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

説明

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

構文

setIdPPartnerMappingNameID(partnerName,userstoreAttr)

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

例

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

setPartnerAlias

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

説明

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

構文

setPartnerAlias(partnerName,partnerType,partnerAlias)

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

例

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

setPartnerIDStoreAndBaseDN

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

説明

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

構文

setPartnerIDStoreAndBaseDN(partnerName,partnerType,storeName,searchBaseDN)

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

例

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

updatePartnerMetadata

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

説明

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

構文

updatePartnerMetadata(partnerName,partnerType,metadataFile)

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

例

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

updatePartnerProperty

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

説明

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

構文

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

引数	定義
partnerName	更新するパートナのID
partnerType	パートナ・タイプを指定します。有効な値は、spまたはidpです。
propName	構成するプロパティの名前。
propValue	設定するプロパティ値。
type	プロパティのデータ型。有効な値は、string、longまたはbooleanです。

例

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

Oracle Access Management Mobile and Socialコマンド

表4-7に示されているWLSTコマンドを使用して、Oracle Access Management Mobile and Social (Mobile and Social)構成オブジェクトを管理します。

表4-7 WLST Mobile and Socialコマンド

コマンド	用途	WLSTでの使用
システム構成コマンド
getRPSystemConfig	システム構成データを取得します。	オンライン
replaceRPSystemConfig	システム構成データを更新します。	オンライン
RPApplicationコマンド
getRPApplications	RPApplicationオブジェクトを取得します。	オンライン
removeRPApplication	指定されたRPApplicationオブジェクトを削除します。	オンライン
displayRPApplication	指定されたRPApplicationオブジェクトを表示します。	オンライン
createRPApplication	新しいRPApplicationオブジェクトを作成します。	オンライン
updateRPApplication	定義済のRPApplicationオブジェクトの値を更新します。	オンライン
ServiceProviderInterfaceコマンド
getServiceProviderInterfaces	RPApplicationオブジェクトを取得します。	オンライン
removeServiceProviderInterface	指定されたRPApplicationオブジェクトを削除します。	オンライン
displayServiceProviderInterface	指定されたRPApplicationオブジェクトを表示します。	オンライン
createServiceProviderInterface	新しいRPApplicationオブジェクトを作成します。	オンライン
updateServiceProviderInterface	定義済のRPApplicationオブジェクトの値を更新します。	オンライン
インターネット・アイデンティティ・プロバイダ・コマンド
getInternetIdentityProviders	インターネット・アイデンティティ・プロバイダ・オブジェクトを取得します。	オンライン
removeInternetIdentityProvider	指定されたインターネット・アイデンティティ・プロバイダ・オブジェクトを削除します。	オンライン
displayInternetIdentityProvider	指定されたインターネット・アイデンティティ・プロバイダ・オブジェクトを表示します。	オンライン
createInternetIdentityProvider	新しいインターネット・アイデンティティ・プロバイダ・オブジェクトを作成します。	オンライン
updateInternetIdentityProvider	定義済のインターネット・アイデンティティ・プロバイダ・オブジェクトの値を更新します。	オンライン
ユーザー属性マッピング・コマンド
getUserAttributeMappings	ユーザー属性マッピング・オブジェクトを取得します。	オンライン
removeUserAttributeMapping	指定されたユーザー属性マッピング・オブジェクトを削除します。	オンライン
displayUserAttributeMapping	指定されたユーザー属性マッピング・オブジェクトを表示します。	オンライン
updateUserAttributeMapping	定義済のユーザー属性マッピング・オブジェクトの値を更新します。	オンライン
ServiceProviderコマンド
createServiceProvider	ServiceProviderを作成します。	オンライン
updateServiceProvider	ServiceProviderを更新します	オンライン
addRelationshipToServiceProvider	サービス・プロバイダに関係を追加します。	オンライン
removeRelationshipFromServiceProvider	サービス・プロバイダから関係を削除します。	オンライン
getServiceProviders	ServiceProviderを取得します。	オンライン
removeServiceProvider	ServiceProviderオブジェクトを削除します。	オンライン
displayServiceProvider	ServiceProviderオブジェクトを表示します。	オンライン
ServiceProfileコマンド
createServiceProfile	サービス・オブジェクトを作成します。	オンライン
updateServiceProfile	サービス・オブジェクトを更新します。	オンライン
removeServiceProfile	サービス・オブジェクトを削除します。	オンライン
displayServiceProfile	サービス・オブジェクトを表示します。	オンライン
getServiceProfiles	すべてのサービス・オブジェクトを取得します。	オンライン
ApplicationProfileコマンド
getApplicationProfiles	すべてのApplicationProfileオブジェクトを一覧表示します。	オンライン
createApplicationProfile	ApplicationProfileを作成します。	オンライン
updateApplicationProfile	ApplicationProfileを更新します。	オンライン
removeApplicationProfile	ApplicationProfileを削除します。	オンライン
displayApplicationProfile	ApplicationProfileを表示します。	オンライン
ServiceDomainコマンド
createServiceDomain	ServiceDomainを作成します。	オンライン
updateServiceDomain	ServiceDomainを更新します。	オンライン
getServiceDomains	ServiceDomainを取得します。	オンライン
removeServiceDomain	ServiceDomainを削除します。	オンライン
displayServiceDomain	ServiceDomainを表示します。	オンライン
SecurityHandlerコマンド
createSecurityHandlerPlugin	SecurityHandlerPluginを作成します。	オンライン
updateSecurityHandlerPlugin	SecurityHandlerPluginを更新します。	オンライン
getSecurityHandlerPlugins	SecurityHandlerPluginを取得します。	オンライン
removeSecurityHandlerPlugin	SecurityHandlerPluginを削除します。	オンライン
displaySecurityHandlerPlugin	SecurityHandlerPluginを表示します。	オンライン
JailBreakingDetectionPolicyコマンド
createJailBreakingDetectionPolicy	JailBreakingDetectionPolicyを作成します。	オンライン
updateJailBreakingDetectionPolicy	JailBreakingDetectionPolicyを更新します。	オンライン
getJailBreakingDetectionPolicys	JailBreakingDetectionPolicyを取得します。	オンライン
removeJailBreakingDetectionPolicy	JailBreakingDetectionPolicyを削除します。	オンライン
displayJailBreakingDetectionPolicy	JailBreakingDetectionPolicyを表示します。	オンライン

getRPSystemConfig

getRPSystemConfig

説明

システム構成情報を取得します。

構文

getRPSystemConfig( )

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

例

getRPSystemConfig( )

replaceRPSystemConfig

replaceRPSystemConfig

説明

特定のシステム構成の値を置換します。

構文

replaceRPSystemConfig(hostURL, proxyProtocol, proxyHost, proxyPort, proxyUsername, proxyPassword, attributeList)

表4-8 replaceRPSystemConfigの引数

引数	定義
hostURL	Mobile and SocialサーバーをホストするマシンのURL。
proxyProtocol	プロキシ・プロトコル(HTTP/HTTPS)。
proxyHost	プロキシ・マシンのURL。
proxyPort	プロキシ・マシンのポート。
proxyUsername	プロキシにアクセスするユーザーの名前。
proxyPassword	プロキシにアクセスするユーザーのパスワード。
attributeList	JSON形式の属性のリスト。 [{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]

例

replaceRPSystemConfig('http://515.server.com','http','server.com','18001','proxyUser','proxyPass','[{aas.rest.service:http://adc514:18001/aas_rest}]')

getRPApplications

getRPApplications

説明

RPApplicationオブジェクトを取得します。

構文

getRPApplications( )

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

例

getRPApplications( )

removeRPApplication

removeRPApplication

説明

指定されたRPApplicationオブジェクトを削除します。

構文

removeRPApplication(name)

ここで、nameは、RPApplicationオブジェクトの名前です。

例

removeRPApplication('TestApp')

displayRPApplication

displayRPApplication

説明

指定されたRPApplicationオブジェクトを表示します。

構文

displayRPApplication(name)

ここで、nameは、RPApplicationオブジェクトの名前です。

例

displayRPApplication('TestApp')

createRPApplication

createRPApplication

説明

新しいRPApplicationオブジェクトを作成します。

構文

createRPApplication(identityProviderNameList, sharedSecret, returnUrl, SPIBindingName, applicationAttributesList, userAttributeMappings, attributeList, mobileApplicationReturnUrl, name, description)

表4-9 createRPApplicationの引数

引数	定義
identityProviderNameList	アイデンティティ・プロバイダのリスト
sharedSecret	共有シークレット。
returnUrl	戻りURL。
SPIBindingName	SPIバインディング名。
applicationAttributesList	JSON形式で指定されるRPApplication属性のリスト。 [{name1:value1},{name2:value2}]
userAttributeMappings	JSON形式で指定されたユーザー属性マッピングのリスト。 [{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]
attributeList	JSON形式で指定されるプロトコル属性のリスト。 [{name1:value1},{name2:value2}]
mobileApplicationReturnUrl	モバイル・アプリケーションの戻りURL。
name	作成するオブジェクトの名前。
description	作成するオブジェクトの説明。

例

createRPApplication('Yahoo,Facebook','mySecret','http://me.com','OAMServiceProviderInterface','[{pratname1:atval1},{pratname2:atval2}]','[{Yahoo:[{uid:email},{mail:email},{zip:postalCode},{country:country}]},{Facebook:[{uid:email},{mail:email},{zip:postalCode},{country:country}]}]','[{atname1:atval2},{atname2:atval2}]','/oam/server','myApp','new Application')

updateRPApplication

updateRPApplication

説明

RPApplicationオブジェクトの特定の値を更新します。

構文

updateRPApplication(identityProviderNameList, sharedSecret, returnUrl, SPIBindingName, applicationAttributesList, userAttributeMappings, attributeList, mobileApplicationReturnUrl, name, description)

表4-10 updateRPApplicationの引数

引数	定義
identityProviderNameList	アイデンティティ・プロバイダのリスト
sharedSecret	共有シークレット。
returnUrl	戻りURL。
SPIBindingName	SPIバインディング名。
applicationAttributesList	JSON形式で指定されるRPApplication属性のリスト。 [{name1:value1},{name2:value2}]
userAttributeMappings	JSON形式で指定されたユーザー属性マッピングのリスト。 [{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]
attributeList	JSON形式で指定されるプロトコル属性のリスト。 [{name1:value1},{name2:value2}]
mobileApplicationReturnUrl	モバイル・アプリケーションの戻りURL。
name	作成するオブジェクトの名前。
description	作成するオブジェクトの説明。

例

updateRPApplication('Facebook,Google','mySecret','http://me.com','OAMServiceProviderInterface','[{pratname1:atval1},{pratname2:atval2}]','userMap1,userMap2','[{atname1:atval2},{atname2:atval2}]','/oam/server','myApp','new Application')

getServiceProviderInterfaces

getServiceProviderInterfaces

説明

サービス・プロバイダ・インタフェース・オブジェクトを取得します。

構文

getServiceProviderInterfaces( )

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

例

getServiceProviderInterfaces( )

removeServiceProviderInterface

removeServiceProviderInterface

説明

指定されたサービス・プロバイダ・インタフェース・オブジェクトを削除します。

構文

removeServiceProviderInterface(name)

ここで、nameは、サービス・プロバイダ・インタフェース・オブジェクトの名前です。

例

removeServiceProviderInterface('TestApp')

displayServiceProviderInterface

displayServiceProviderInterface

説明

指定されたサービス・プロバイダ・インタフェース・オブジェクトを表示します。

構文

displayServiceProviderInterface(name)

ここで、nameは、サービス・プロバイダ・インタフェース・オブジェクトの名前です。

例

displayServiceProviderInterface('TestApp')

createServiceProviderInterface

createServiceProviderInterface

説明

新しいサービス・プロバイダ・インタフェース・オブジェクトを作成します。

構文

createServiceProviderInterface(idpSelectorImpl, postIDPSelectorImpl, idpInteractionProviderImpl, registrationStatusCheckImpl, registrationTaskFlowProviderImpl, sessionCreationProviderImpl, attributeList, name, description)

表4-11 createServiceProviderInterfaceの引数

引数	定義
idpSelectorImpl
postIDPSelectorImpl
idpInteractionProviderImpl
registrationStatusCheckImpl
registrationTaskFlowProviderImpl
sessionCreationProviderImpl
attributeList	JSON形式の属性のリスト。 [{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]
name	作成するオブジェクトの名前。
description	作成するオブジェクトの説明。

例

createServiceProviderInterface('idp','postIDP','idpInteraction','regStatus','regTask','sessionPro','[{pratname1:atval1},{pratname2:atval2}]','mySPIBind','new SPI Binding')

updateServiceProviderInterface

updateServiceProviderInterface

説明

サービス・プロバイダ・インタフェース・オブジェクトの特定の値を更新します。

構文

updateServiceProviderInterface(idpSelectorImpl, postIDPSelectorImpl, idpInteractionProviderImpl, registrationStatusCheckImpl, registrationTaskFlowProviderImpl, sessionCreationProviderImpl, attributeList, name, description)

表4-12 updateServiceProviderInterfaceの引数

引数	定義
idpSelectorImpl
postIDPSelectorImpl
idpInteractionProviderImpl
registrationStatusCheckImpl
registrationTaskFlowProviderImpl
sessionCreationProviderImpl
attributeList	JSON形式の属性のリスト。 [{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]
name	作成するオブジェクトの名前。
description	作成するオブジェクトの説明。

例

updateServiceProviderInterface('idp','postIDP','idpInteraction','regStatus','regTask','sessionPro','[{pratname1:atval1},{pratname2:atval2}]','mySPIBind','new SPI Binding')

getInternetIdentityProviders

getInternetIdentityProviders

説明

インターネット・アイデンティティ・プロバイダ・オブジェクトを取得します。

構文

getInternetIdentityProviders( )

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

例

getInternetIdentityProviders( )

removeInternetIdentityProvider

removeInternetIdentityProvider

説明

指定されたインターネット・アイデンティティ・プロバイダ・オブジェクトを削除します。

構文

removeInternetIdentityProvider(name)

ここで、nameは、インターネット・アイデンティティ・プロバイダ・オブジェクトの名前です。

例

removeInternetIdentityProvider('TestApp')

displayInternetIdentityProvider

displayInternetIdentityProvider

説明

指定されたインターネット・アイデンティティ・プロバイダ・オブジェクトを表示します。

構文

displayInternetIdentityProvider(name)

ここで、nameは、インターネット・アイデンティティ・プロバイダ・オブジェクトの名前です。

例

displayInternetIdentityProvider('TestApp')

createInternetIdentityProvider

createInternetIdentityProvider

説明

新しいインターネット・アイデンティティ・プロバイダ・オブジェクトを作成します。

構文

createInternetIdentityProvider(icon, protocolType, protocolAttributeList, providerImplClass, attributeList, name, description)

表4-13 createInternetIdentityProviderの引数

引数	定義
icon	アイコンの名前。
protocolType	プロトコルのタイプはOpenID、OAuthまたはCustomのいずれかになります。
protocolAttributeList	JSON形式で指定されるプロトコル属性のリスト。 [{name1:value1},{name2:value2}]
providerImplClass	プロバイダの実装クラス。
attributeList	JSON形式で指定されるプロトコル属性のリスト。 [{name1:value1},{name2:value2}]
name	作成するプロバイダの名前。
description	作成するプロバイダの説明。

例

createInternetIdentityProvider('myIcon','myType','[{pratname1:atval1},{pratname2:atval2}]','[{atname1:atval1},{atname2:atval2}]','class','myProvider','new Identity Provider')

注意: createInternetIdentityProviderをスクリプトの中で使用してFoursquareおよびWindows Liveのプロバイダ構成を作成することもできます。次は、Foursquare用のスクリプトの例です。スクリプトを実行する前に、WebLogic Serverに接続するために使用するusernameとpassword、そしてコンシューマのキーとシークレット値(引用符で囲む)を更新してください: url = 't3://localhost:7001' username='xxxxxx' password='xxxxxx' connect(username,password,url) domainRuntime() print "Foursquare OAuth" print "---------------------" createInternetIdentityProvider( 'Foursquare.gif', 'OAuth', '[{oauth.authorization.url: "https://foursquare.com/oauth2/authorize"}, {oauth.accesstoken.url:"https://foursquare.com/oauth2/access_token"}, {oauth.profile.url: "https://api.foursquare.com/v2/users/self"}, {oauth.consumer.key:""}, {oauth.consumer.secret:""}, {oauth.rpinstance.name:""}, {oauth.rpinstance.url:""}]', '[{id:id}, {firstname:firstname}, {lastname:lastname}, {contact.email:contact.email}, {homecity:homecity}, {gender:gender}, {photo:photo}]', 'oracle.security.idaas.rp.oauth.provider.FoursquareImpl', 'Foursquare', 'Foursquare OAuth Provider') disconnect() exit()

updateInternetIdentityProvider

updateInternetIdentityProvider

説明

インターネット・アイデンティティ・プロバイダ・オブジェクトの特定の値を更新します。

構文

updateInternetIdentityProvider(icon, protocolType, protocolAttributeList, attributeList, providerImplClass, name, description)

表4-14 updateInternetIdentityProviderの引数

引数	定義
icon	アイコンの名前。
protocolType	プロトコルのタイプはOpenID、OAuthまたはCustomのいずれかになります。
protocolAttributeList	JSON形式で指定されるプロトコル属性のリスト。 [{name1:value1},{name2:value2}]
providerImplClass	プロバイダの実装クラス。
attributeList	JSON形式で指定されるプロトコル属性のリスト。 [{name1:value1},{name2:value2}]
name	更新するプロバイダの名前。
description	更新するプロバイダの説明。

例

updateInternetIdentityProvider('myIcon','myType','[{pratname1:atval1},{pratname2:atval2}]','[{atname1:atval1},{atname2:atval2}]','class','myProvider','new Identity Provider')

getUserAttributeMappings

getUserAttributeMappings

説明

ユーザー属性マッピング・オブジェクトを取得します。

構文

getUserAttributeMappings( )

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

例

getUserAttributeMappings( )

removeUserAttributeMapping

removeUserAttributeMapping

説明

指定されたユーザー属性マッピング・オブジェクトを削除します。

構文

removeUserAttributeMapping(name)

ここで、nameは、ユーザー属性マッピング・オブジェクトの名前です。

例

removeUserAttributeMapping('TestApp')

displayUserAttributeMapping

displayUserAttributeMapping

説明

指定されたユーザー属性マッピング・オブジェクトを表示します。

構文

displayUserAttributeMapping(name)

ここで、nameは、ユーザー属性マッピング・オブジェクトの名前です。

例

displayUserAttributeMapping('TestApp')

updateUserAttributeMapping

updateUserAttributeMapping

説明

ユーザー属性・マッピング・オブジェクトの特定の値を更新します。

構文

updateUserAttributeMapping(application, idp, name, appProtocolAttributeList)

表4-15 updateUserAttributeMappingの引数

引数	定義
application	アプリケーション名。
idp	アイデンティティ・プロバイダの名前。
name	作成するオブジェクトの名前。
appProtocolAttributeList	JSON形式のプロトコル属性のリスト。 [{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]

例

updateUserAttributeMapping('myApp','myProvider','myMap','[{pratname1:atval1},{pratname2:atval2}]')

createServiceProvider

createServiceProvider

説明

サービス・プロバイダを作成します。

構文

createServiceProvider(serviceProviderImpl, serviceProviderType, relationshipList, paramList, name, description)

表4-16 createServiceProviderの引数

引数	定義
serviceProviderImpl	サービス・プロバイダの実装。
serviceProviderType	サービス・プロバイダのタイプ。許容可能な値は、Authorization、AuthenticationまたはUserProfileのいずれかです。
relationshipList	JSON形式で指定されたこのサービス・プロバイダの関係: [{relationship:relname,description:descrip,directional1:{name:dirname,description:descrip,providerRelation:relname,entityURIAttrName:uri,scopeAllLevelAttrName:toTop},directional2:{name:dirname,description:descrip,providerRelation:relname,entityURIAttrName:uri,scopeAllLevelAttrName:toTop}}]
paramList	JSON形式で指定されたこのサービス・プロバイダのパラメータ: [{name1:value1},{name2:value2}...]
name	サービス・プロバイダの名前。
description	サービス・プロバイダの説明。

例

createServiceProvider('oracle.security.idaas.rest.provider.token.MobileOAMTokenSer
viceProvider', 'Authentication', '[]','[{OAM_VERSION:OAM_11G},{WEBGATE_
ID:accessgate-oic},{ENCRYPTED_PASSWORD:"password"},{DEBUG_VALUE:0},{TRANSPORT_
SECURITY:OPEN},{OAM_SERVER_1:"localhost:5575"},{OAM_SERVER_1_MAX_CONN:4},{OAM_
SERVER_2:"oam_server_2:5575"},{OAM_SERVER_2_MAX_CONN:4}]',
'MobileOAMAuthentication', 'Out Of The Box Mobile Oracle Access Manager (OAM)
 Authentication Service Provider')

updateServiceProvider

updateServiceProvider

説明

サービス・プロバイダを更新します。

構文

updateServiceProvider(serviceProviderImpl, serviceProviderType, relationshipList, paramList, name, description)

表4-17 updateServiceProviderの引数

引数	定義
serviceProviderImpl	サービス・プロバイダの実装
serviceProviderType	サービス・プロバイダのタイプ - Authorization、Authentication、UserProfileのいずれか。
relationshipList	JSON形式で指定されたこのサービス・プロバイダの関係。 [{relationship:relname,description:descrip, directional1:{name:dirname,description:descrip,provider Relation:relname,entityURIAttrName:uri,scopeAllLevelAtt rName:toTop},directional2:{name:dirname,description:des crip,providerRelation:relname,entityURIAttrName:uri,sco peAllLevelAttrName:toTop}}]
paramList	JSON形式で指定されたこのサービス・プロバイダのパラメータ。 [{name1:value1},{name2:value2}...]
name	サービス・プロバイダの名前。
description	サービス・プロバイダの説明。

例

updateServiceProvider('oracle.security.idaas.rest.provider.cruds.ids.
IDSCRUDSServiceProvider', 'UserProfile', '[{relationship:people_groups,
directional1:{name:memberOf, providerRelation:user_memberOfGroup,
entityURIAttrName:person-uri}, directional2:{name:members,
providerRelation:groupMember_user,entityURIAttrName:group-uri }},
{relationship:people_manager, directional1:{name:manager,providerRelation:manager,
entityURIAttrName:report-uri,scopeAllLevelAttrName:toTop},
directional2:{name:reports , providerRelation:reportee,
qntityURIAttrName:manager-uri, scopeAllLevelAttrName:all}},
{relationship:groupMemberOf_groupMembers , directional1:{name:groupMemberOf,
providerRelation:group_memberOfGroup,entityURIAttrName:member-uri},
directional2:{name:groupMembers, providerRelation:groupMember
_group,entityURIAttrName:group-uri }},{relationship:personOwner_ownerOf,
directional1:{name:ownerOf, providerRelation:user_
ownerOfGroup,entityURIAttrName:owner-uri},
directional2:{name:personOwner,providerRelation:groupOwner_
user,entityURIAttrName:group-uri}},{relationship:groupOwner_groupOwnerOf,
directional1:{name:groupOwner, providerRelation:group_
ownerOfGroup,entityURIAttrName:group-uri}, directional2:{name:groupOwnerOf,
providerRelation:groupOwner_group,entityURIAttrName:owner-uri
}}]','[{oracle.ids.name:userrole},{accessControl:false}]', 'UserProfile', 'Out Of
The Box User Profile Service Provider')

addRelationshipToServiceProvider

addRelationshipToServiceProvider

説明

サービス・プロバイダに関係を追加します。

構文

addRelationshipToServiceProvider(name, relationshipList)

表4-18 addRelationshipToServiceProviderの引数

引数	定義
name	サービス・プロバイダの名前。
relationshipList	JSON形式で指定されたこのサービス・プロバイダの関係。 [{relationship:relname,description:descrip,directional1: {name:dirname,description:descrip,providerRelation:relname, entityURIAttrName:uri,scopeAllLevelAttrName:toTop}, directional2:{name:dirname,description:descrip, providerRelation:relname,entityURIAttrName:uri, scopeAllLevelAttrName:toTop}}]

例

addRelationshipToServiceProvider('idsprovider1','[{relationship:relname,
description:descrip, directional1:{name:dirname,description:descrip,
providerRelation:relname,entityURIAttrName:uri,scopeAllLevelAttrName:toTop},
directional2:{name:dirname,description:descrip,
providerRelation:relname,entityURIAttrName:uri,scopeAllLevelAttrName:toTop}}]

removeRelationshipFromServiceProvider

removeRelationshipFromServiceProvider

説明

サービス・プロバイダから関係を削除します。

構文

removeRelationshipFromServiceProvider

表4-19 removeRelationshipFromServiceProviderの引数

引数	定義
name	サービス・ドメインの名前。
relationshipList	このサービス・プロバイダの関係名。

例

removeRelationshipFromServiceProvider('idsprovider1','relname')

getServiceProviders

getServiceProviders

説明

サービス・プロバイダを取得します。

構文

getServiceProviders()

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

例

getServiceProviders()

次に、サンプル出力を示します。

ServiceProvider: UserProfile1ServiceProvider: JWTAuthenticationServiceProvider: UserProfileServiceProvider: MobileOAMAuthenticationServiceProvider: OAMAuthenticationServiceProvider: MobileJWTAuthenticationServiceProvider: sampleauthzserviceproviderServiceProvider: InternetIdentityAuthenticationServiceProvider: OAMAuthorization

removeServiceProvider

removeServiceProvider

説明

このコマンドは、ServiceProviderオブジェクトを削除します。

構文

removeServiceProvider(name)

ここで、nameは、ServiceProviderオブジェクトの名前です。

例

removeServiceProvider('name')

displayServiceProvider

displayServiceProvider

説明

このコマンドは、ServiceProviderオブジェクトを表示します。

構文

displayServiceProvider(name)

ここで、nameは、ServiceProviderオブジェクトの名前です。

例

displayServiceProvider('OAMAuthentication')

次に、サンプル出力を示します。

Displaying: ServiceProvider : OAMAuthenticationReadOnly = 0Description = Out Of The Box Oracle Access Manager (OAM) Authentication Token Service ProviderParam = ...eventProvider = 1objectName = com.oracle.idaas:name=OAMAuthentication,type=Xml.ServiceProvider,Xml=MobileServiceSystemMBean = 0ServiceProviderType = AuthenticationName = OAMAuthenticationConfigMBean = 1ServiceProviderImpl = oracle.security.idaas.rest.provider.token.OAMSDKTokenServiceProviderRelationship = array(javax.management.openmbean.CompositeData,[])eventTypes = array(java.lang.String,['jmx.attribute.change'])RestartNeeded = 0

createServiceProfile

createServiceProfile

説明

サービスを作成します。

構文

createServiceProfile(serviceProvider, supportedTokenList, paramList, endPoint, name, description, enabled)

表4-20 createServiceProfileの引数

引数	定義
serviceProvider	サービス・プロバイダの名前。
supportedTokenList	JSON形式で指定されたサポート対象トークンのリスト。 {type,...} ここで、typeは、CLIENTTOKEN、USERTOKEN、ACCESSTOKENまたはCLIENTREGHANDLEとして定義されます。
paramList	JSON形式で指定されたこのサービスのパラメータのリスト。 [{name1:value1},{name2:value2}...]
endPoint	サービス・エンドポイント。
name	サービスの名前。
description	サービスの説明。
enabled	サービスを有効にするか、無効にするかを示します。ブール・フラグ。

例

createServiceProfile('OAMAuthentication','CLIENTTOKEN,ACCESSTOKEN,USERTOKEN','[]',
'/oamauthentication','OAMAuthentication','Out Of The Box Oracle Access Manager
(OAM) Authentication Token Service',true)

updateServiceProfile

updateServiceProfile

説明

サービスを更新します。

構文

updateServiceProfile(serviceProvider, supportedTokenList, paramList, endPoint, name, description, enabled)

表4-21 updateServiceProfileの引数

引数	定義
serviceProvider	サービス・プロバイダの名前。
supportedTokenList	JSON形式で指定されたサポート対象トークンのリスト。 {type,...} ここで、typeは、CLIENTTOKEN、USERTOKEN、ACCESSTOKENまたはCLIENTREGHANDLEとして定義されます。
paramList	JSON形式で指定されたこのサービスのパラメータのリスト。 [{name1:value1},{name2:value2}...]
endPoint	サービス・エンドポイント。
name	サービスの名前。
description	サービスの説明。
enabled	サービスを有効にするか、無効にするかを示します。ブール・フラグ。

例

updateServiceProfile('MobileJWTAuthentication','CLIENTREGHANDLE,
ACCESSTOKEN,USERTOKEN','[]','/mobilejwtauthentication','MobileJWTAuthentication',
'Out Of The Box Mobile Java Web Token (JWT) Authentication Service Provider',true)

removeServiceProfile

removeServiceProfile

説明

このコマンドは、サービス・オブジェクトを削除します。

構文

removeServiceProfile(name)

ここで、nameは、削除するサービスの名前です。

例

removeServiceProfile('myService')

displayServiceProfile

displayServiceProfile

説明

このコマンドは、サービス・オブジェクトを表示します。

構文

displayServiceProfile(name)

ここで、nameは、表示するサービス・プロファイルの名前です。

例

displayServiceProfile('OAMAuthorization')

次に、サンプル出力を示します。

Displaying: ServiceProfile : OAMAuthorizationReadOnly = 0Enabled = 1Description = Out Of The Box Oracle Access Manager (OAM) Authorization Service ProviderParam = array(javax.management.openmbean.CompositeData,[])eventProvider = 1SystemMBean = 0objectName = com.oracle.idaas:name=OAMAuthorization,type=Xml.ServiceProfile,Xml=MobileServiceSupportedToken = array(java.lang.String,[])ServiceProviderType = AuthorizationServiceProviderName = OAMAuthorizationName = OAMAuthorizationConfigMBean = 1ServiceEndPoint = /oamauthorizationeventTypes = array(java.lang.String,['jmx.attribute.change'])RestartNeeded = 0

getServiceProfiles

getServiceProfiles

説明

すべてのサービス・オブジェクトを取得します。

構文

getServiceProfiles()

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

例

getServiceProfiles()

次に、サンプル出力を示します。

ServiceProfile: UserProfile1ServiceProfile: OAMAuthenticatioServiceProfile: sampleauthzserviceServiceProfile: JWTAuthenticationServiceProfile: UserProfileServiceProfile: MobileOAMAuthenticationServiceProfile: OAMAuthenticationServiceProfile: MobileJWTAuthenticationServiceProfile: InternetIdentityAuthenticationServiceProfile: OAMAuthorizationServiceProfile: JWTAuthentication1

getApplicationProfiles

getApplicationProfiles

説明

ApplicationProfileオブジェクトを一覧表示します。

構文

getApplicationProfiles()

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

例

getApplicationProfiles()

次に、サンプル出力を示します。

Contract: MobileExpenseReport1
Contract: MobileAgent2
Contract: MobileBusinessTestApp01
Contract: MobileAgent1
Contract: profileid1
Contract: samplemobileapp2
Contract: profileid2
Contract: samplemobileapp1

createApplicationProfile

createApplicationProfile

説明

ApplicationProfileを作成します。

構文

createApplicationProfile(paramList, mobileAppProfileStr, name, description)

表4-22 createApplicationProfileの引数

引数	定義
paramList	JSON形式で指定されたこのサービスのパラメータのリスト。 [{name1:value1},{name2:value2}...]
mobileAppProfileStr	JSON形式で指定されたモバイル・アプリケーション・プロファイル文字列。 [{clientAppConfigParam:[{name:value},{name:value}], jailBreakingDetectionPolicyName:name}]
name	IDaaSクライアントの名前。
description	IDaaSクライアントの説明。

例

createApplicationProfile('[{Mobile.clientRegHandle.baseSecret:welcome1},]',
'[{clientAppConfigParam:[{Mobileparam1:Mobileparam1Value},
{IOSURLScheme:"samplemobileapp1://"},
{AndroidPackage:oracle.android.samplemobileapp1},
{AndroidAppSignature:samplemobileapp1signature}],
jailBreakingDetectionPolicyName:defaultJailBreakingDetectionPolicy}]',
'samplemobileapp1','Sample Mobile App 1')

createApplicationProfile('[{userId4BasicAuth:rest_client1},
{sharedSecret4BasicAuth:"9Qo9olLIl5gDwESYR0hOgw=="},
{signatureAlgorithm:SHA-1}]','','profileid1','OIC Application Profile 1')

updateApplicationProfile

updateApplicationProfile

説明

ApplicationProfileを更新します。

構文

updateApplicationProfile(paramList, mobileAppProfileStr, name, description)

表4-23 updateApplicationProfileの引数

引数	定義
paramList	JSON形式で指定されたこのサービスのパラメータのリスト。 [{name1:value1},{name2:value2}...]
mobileAppProfileStr	JSON形式で指定されたモバイル・アプリケーション・プロファイル文字列。 [{clientAppConfigParam:[{name:value},{name:value}], jailBreakingDetectionPolicyName:name}] clientAppConfigParamの値は、管理コンソールの「アプリケーション・プロファイル構成」ページで定義されているものと一致している必要があります。「構成設定」という見出しの下に指定されている項目は、WLST 'clientAppConfigParam'で設定されます。
name	IDaaS (Identity as a Service)クライアントの名前。
description	IDaaS (Identity as a Service)クライアントの説明。

例

updateApplicationProfile('[{Mobile.clientRegHandle.baseSecret:welcome1}]','
[{clientAppConfigParam:[{ProfileCacheDuration:60},
{AuthenticationRetryCount:3},{AllowOfflineAuthentication:false},
{ClaimAttributes:"oracle:idm:claims:client:geolocation,
oracle:idm:claims:client:imei,oracle:idm:claims:client:jailbroken,
oracle:idm:claims:client:locale,oracle:idm:claims:client:macaddress,
oracle:idm:claims:client:networktype,oracle:idm:claims:client:ostype,
oracle:idm:claims:client:osversion,oracle:idm:claims:client:phonecarriername,
oracle:idm:claims:client:phonenumber,oracle:idm:claims:client:sdkversion,
oracle:idm:claims:client:udid,oracle:idm:claims:client:vpnenabled"},
{RPWebView:Embedded},{URLScheme:"exp://"},
{IOSBundleID:com.oraclecorp.internal.ExpenseReportApp},
{AndroidAppSignature:"xmlns:xsi=\
'http://www.w3.org/2001/XMLSchema-instance\' 
xsi:nil=\'true\'"},{AndroidPackage:"xmlns:xsi=\'
http://www.w3.org/2001/XMLSchema-instance\' xsi:nil=\'true\'"}],
jailBreakingDetectionPolicyName:DefaultJailBreakingDetectionPolicy}]',
'ExpenseApp','OIC Test Expense Sample App')

removeApplicationProfile

removeApplicationProfile

説明

このコマンドは、ApplicationProfileを削除します。

構文

removeApplicationProfile(name)

ここで、nameは、削除するApplicationProfileの名前です。

例

removeApplicationProfile('name')

displayApplicationProfile

displayApplicationProfile

説明

このコマンドは、指定されたApplicationProfileを表示します。

構文

dislayApplicationProfile(name)

ここで、nameは、削除するApplicationProfileの名前です。

例

displayApplicationProfile('MobileAgent1')

次に、サンプル出力を示します。

Displaying: ApplicationProfile : MobileAgent1
ReadOnly = 0
ConfigMBean = 1
Name = MobileAgent1
MobileAppProfile = None
Description = Mobile Agent App 1
Param =
array(javax.management.openmbean.CompositeData,[javax.management.openmbean.Composi
teDataSupport(compositeType=javax.management.openmbean.CompositeType(name=com.orac
le.xmlns.idm.idaas.idaas_config_11_1_2_0_0.Attribute,items=((itemName=name,
itemType=javax.management.openmbean.SimpleType(name=java.lang.String)),
(itemName=secretValue,itemType=javax.management.openmbean.ArrayType(name=[Ljava.
lang.Character;,dimension=1,elementType=javax.management.openmbean.SimpleType(name
=java.lang.Character),primitiveArray=false)),(itemName=value,itemType=javax.manage
ment.openmbean.SimpleType(name=java.lang.String)))),contents={name=Mobile.reauthnF
orRegNewClientApp, secretValue=null, value=true}),
javax.management.openmbean.CompositeDataSupport(compositeType=javax.management.ope
nmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0.
Attribute,items=((itemName=name,itemType=javax.management.openmbean.SimpleType(nam
e=java.lang.String)),(itemName=secretValue,itemType=javax.management.openmbean.Arr
ayType(name=[Ljava.lang.Character;,dimension=1,elementType=javax.management.openmb
ean.SimpleType(name=java.lang.Character),primitiveArray=false)),(itemName=value,it
emType=javax.management.openmbean.SimpleType(name=java.lang.String)))),contents={n
ame=Mobile.clientRegHandle.baseSecret, secretValue=[Ljava.lang.Character;@11910bd,
value=idaas.ApplicationProfile[MobileAgent1].param[Mobile.clientRegHandle.baseSecr
et]})])
eventProvider = 1
SystemMBean = 0
objectName =
com.oracle.idaas:name=MobileAgent1,type=Xml.ApplicationProfile,Xml=MobileService
eventTypes = array(java.lang.String,['jmx.attribute.change'])
RestartNeeded = 0

createServiceDomain

createServiceDomain

説明

ServiceDomainを作成します。

構文

createServiceDomain(securityHandlerPlugin,serviceBindingList,
clientAppBindingList,mobileAuthStyle,serviceDomainType,name,description)

表4-24 createServiceDomainの引数

引数	定義
securityHandlerPlugin	securityHandlerPluginの名前。
serviceBindingList	ServiceBindingオブジェクトのリスト。形式は次のとおりです: [{serviceName:UserProfile,allowRead:true, allowWrite:true},{serviceName:UserProfile1, allowRead:true,allowWrite:true, requiredToken:[{tokenService:JWTAuthentication, tokenType:{ACCESSTOKEN}}]}, {serviceName:usertokenserviceformobile, requiredToken:[{tokenService:mobilesecurityservice1, tokenType:{ACCESSTOKEN,CLIENTTOKEN}}]}, {serviceName:mobilesecurityservice1}, {serviceName:JWTAuthentication1}, {serviceName:OAMAuthorization}]
clientAppBindingList	次の形式で指定されたクライアント・アプリケーションのリスト。 [{appName:UserProfile,mobileBinding: [{SSOinclusion:true,SSOpriority:4}]
mobileAuthStyle	モバイル認証スタイル。
serviceDomainType	サービス・ドメインのタイプ。
name	ServiceDomainの名前。
description	ServiceDomainの説明。

例

createServiceDomain('JunitDebugSecurityHandlerPlugin','[{serviceName:UserProfile,
allowRead:true,allowWrite:true},{serviceName:UserProfile1,allowRead:true,
allowWrite:true,requiredToken:[{tokenService:JWTAuthentication1,
tokenType:ACCESSTOKEN}]},{serviceName:JWTAuthentication},{serviceName:OAMAuthentication},{serviceName:JWTAuthentication1},{serviceName:OAMAuthorization,
allowRead:true,allowWrite:false,requiredToken:[{tokenService:OAMAuthentication,
tokenType:USERTOKEN}]}]','[{appName:MobileAgent1,mobileBinding:
[{SSOinclusion:true,SSOpriority:1}]},{appName:MobileBusinessTestApp01,
mobileBinding:[{SSOinclusion:true}]},{appName:MobileAgent2,mobileBinding:
[{SSOinclusion:true,SSOpriority:2}]},{appName:MobileExpenseReport1,
mobileBinding:[{SSOinclusion:false}]},{appName:profileid1}]','','DESKTOP',
'Default','DefaultService Domain ServiceBinding without any requiredToken')

updateServiceDomain

updateServiceDomain

説明

ServiceDomainを更新します。

構文

updateServiceDomain(securityHandlerPlugin, serviceBindingList, clientAppBindingList, mobileAuthStyle, serviceDomainType, name, description)

表4-25 createServiceDomainの引数

引数	定義
securityHandlerPlugin	SecurityHandlerPluginの名前。
serviceBindingList	ServiceBindingオブジェクトのリスト。形式は次のとおりです: [{serviceName:UserProfile,allowRead:true, allowWrite:true},{serviceName:UserProfile1, allowRead:true,allowWrite:true, requiredToken:[{tokenService:JWTAuthentication, tokenType:{ACCESSTOKEN}}]}, {serviceName:usertokenserviceformobile, requiredToken:[{tokenService:mobilesecurityservice1, tokenType:{ACCESSTOKEN,CLIENTTOKEN}}]}, {serviceName:mobilesecurityservice1}, {serviceName:JWTAuthentication1}, {serviceName:OAMAuthorization}]
clientAppBindingList	次の形式で指定されたクライアント・アプリケーションのリスト。 [{appName:UserProfile,mobileBinding: [{SSOinclusion:true,SSOpriority:4}]
mobileAuthStyle	モバイル認証スタイル。
serviceDomainType	サービス・ドメインのタイプ。
name	ServiceDomainの名前。
description	ServiceDomainの説明。

例

updateServiceDomain('JunitDebugSecurityHandlerPlugin','[{serviceName:UserProfile,
allowRead:true,allowWrite:true},{serviceName:UserProfile1,allowRead:true,
allowWrite:true,requiredToken:[{tokenService:JWTAuthentication1,
tokenType:ACCESSTOKEN}]},{serviceName:JWTAuthentication},
{serviceName:OAMAuthentication},{serviceName:JWTAuthentication1},
{serviceName:OAMAuthorization,allowRead:true,allowWrite:false,
requiredToken:[{tokenService:OAMAuthentication,tokenType:USERTOKEN}]}]',
'[{appName:MobileAgent1,mobileBinding:[{SSOinclusion:true,SSOpriority:1}]},
{appName:MobileBusinessTestApp01,mobileBinding:[{SSOinclusion:true}]},
{appName:MobileAgent2,mobileBinding:[{SSOinclusion:true,SSOpriority:2}]},
{appName:MobileExpenseReport1,mobileBinding:[{SSOinclusion:false}]},
{appName:profileid1}]','','DESKTOP','Default',
'Default Service Domain ServiceBinding without any requiredToken')

getServiceDomains

getServiceDomains

説明

ServiceDomainを取得します。

構文

getServiceDomains()

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

例

getServiceDomain()

次に、サンプル出力を示します。

ServiceDomain: MobileServiceDomainUTRegServiceDomain: MobileRPServiceDomainServiceDomain: Contract1ServiceDomain: MobileJWTServiceDomainServiceDomain: MobileRPServiceDomainUTRegServiceDomain: MobileContractServiceDomain: DefaultServiceDomain: MobileServiceDomain

removeServiceDomain

removeServiceDomain

説明

ServiceDomainを削除します。

構文

removeServiceDomain(name)

ここで、nameは、削除するServiceDomainの名前です。

例

removeServiceDomain('name')

displayServiceDomain

displayServiceDomain

説明

ServiceDomainを表示します。

構文

displayServiceDomain(name)

例

displayServiceDomain('name')

次に、サンプル出力を示します。

Displaying: ServiceDomain : Contract1
ReadOnly = 0
Description = Service Domain 1 using HTTPBasic or Token based Client Token
eventProvider = 1
SystemMBean = 0
objectName = com.oracle.idaas:name=Contract1,type=Xml.ServiceDomain,Xml=MobileService
MobileAuthStyle = None
ServiceBinding = array(javax.management.openmbean.CompositeData,[javax.management.openmbean.
CompositeDataSupport(compositeType=javax.management.openmbean.CompositeType(name=
com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0.TServiceBinding,
items=((itemName=allowRead,itemType=javax.management.openmbean.SimpleType(name=
java.lang.Boolean)),(itemName=allowWrite,itemType=javax.management.openmbean.
SimpleType(name=java.lang.Boolean)),(itemName=requiredToken,itemType=javax.managem
ent.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_
0.TRequiredToken,items=((itemName=tokenService,itemType=javax.management.openmbean
.SimpleType(name=java.lang.String)),(itemName=tokenType,itemType=javax.management.
openmbean.ArrayType(name=[Ljava.lang.String;,dimension=1,elementType=javax.managem
ent.openmbean.SimpleType(name=java.lang.String),primitiveArray=false))))),(itemNam
e=serviceName,itemType=javax.management.openmbean.SimpleType(name=java.lang.String
)))),contents={allowRead=true, allowWrite=true,
requiredToken=javax.management.openmbean.CompositeDataSupport(compositeType=javax.
management.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_
11_1_2_0_0.TRequiredToken,
items=((itemName=tokenService,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)),(itemName=tokenType,itemType=javax.management.openmbean.
ArrayType(name=[Ljava.lang.String;,dimension=1,elementType=javax.management.
openmbean.SimpleType(name=java.lang.String),primitiveArray=false)))),
contents={tokenService=JWTAuthentication, tokenType=[Ljava.lang.String;@d0fbf2}),
serviceName=UserProfile}),
javax.management.openmbean.CompositeDataSupport(compositeType=javax.management.
openmbean.CompositeType(name=
com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0.TServiceBinding,
items=((itemName=allowRead,itemType=javax.management.openmbean.SimpleType(name=
java.lang.Boolean)),(itemName=allowWrite,itemType=javax.management.openmbean.
SimpleType(name=java.lang.Boolean)),(itemName=requiredToken,itemType=
javax.management.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_
config_11_1_2_0_0.TRequiredToken,
items=((itemName=tokenService,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)),(itemName=tokenType,itemType=javax.management.openmbean.
ArrayType(name=[Ljava.lang.String;,dimension=1,elementType=javax.management.
openmbean.SimpleType(name=java.lang.String),primitiveArray=false))))),
(itemName=serviceName,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)))),contents={allowRead=null, allowWrite=null,
requiredToken=null, serviceName=JWTAuthentication})])MobileCredLevelForRegApp = NoneServiceDomainType = DESKTOPName = Contract1ConfigMBean = 1
ClientAppBinding =
array(javax.management.openmbean.CompositeData,
[javax.management.openmbean.CompositeDataSupport(compositeType=javax.management.
openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0
TApplicationBinding,items=((itemName=appName,itemType=javax.management.openmbean.
SimpleType(name=java.lang.String)),(itemName=mobileBinding,itemType=javax.
management.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.
idaas_config_11_1_2_0_0.TMobileBinding,items=((itemName=SSOinclusion,
itemType=javax.management.openmbean.SimpleType(name=java.lang.Boolean)),
(itemName=SSOpriority,itemType=javax.management.openmbean.SimpleType(name=
java.lang.Short))))))),contents={appName=profileid1, mobileBinding=null}),
javax.management.openmbean.CompositeDataSupport(compositeType=javax.management.
openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0
.TApplicationBinding,items=((itemName=appName,itemType=javax.management.openmbean
.SimpleType(name=java.lang.String)),(itemName=mobileBinding,itemType=javax.manage
ment.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas
.idaas_config_11_1_2_0_0.TMobileBinding,items=
((itemName=SSOinclusion,itemType=javax.management.openmbean.SimpleType(name=
java.lang.Boolean)),(itemName=SSOpriority,itemType=javax.management.openmbean.
SimpleType(name=java.lang.Short))))))),contents={appName=profileid2,
mobileBinding=null})])SecurityHandlerPluginName = NoneeventTypes = array(java.lang.String,['jmx.attribute.change'])RestartNeeded = 0

createSecurityHandlerPlugin

createSecurityHandlerPlugin

説明

SecurityHandlerPluginを作成します。

構文

createSecurityHandlerPlugin(securityHandlerClass, paramList, name, description)

表4-26 createSecurityHandlerPluginの引数

引数	定義
securityHandlerClass	セキュリティ・ハンドラ・クラスの名前。
paramList	パラメータのリスト。
name	SecurityHandlerPluginの名前。
description	SecurityHandlerPluginの説明。

例

createSecurityHandlerPlugin('oracle.security.idaas.rest.provider.plugin.impl.DefaultMobileSecurityHandlerImpl','[{allowJailBrokenDevices:false},{requiredHardwareIds:MAC_ADDRESS},{requiredDeviceProfileAttrs:OSType OSVersion isJailBroken clientSDKVersion}]','DefaultSecurityHandlerPlugin','')

updateSecurityHandlerPlugin

updateSecurityHandlerPlugin

説明

SecurityHandlerPluginを更新します。

構文

updateSecurityHandlerPlugin(securityHandlerClass, paramList, name, description)

表4-27 createSecurityHandlerPluginの引数

引数	定義
securityHandlerClass	セキュリティ・ハンドラ・クラスの名前。
paramList	パラメータのリスト。
name	SecurityHandlerPluginの名前。
description	SecurityHandlerPluginの説明。

例

updateSecurityHandlerPlugin('oracle.security.idaas.rest.provider.plugin.impl.DefaultMobileSecurityHandlerImpl','[{allowJailBrokenDevices:false},{requiredHardwareIds:MAC_ADDRESS},{requiredDeviceProfileAttrs:OSType OSVersion isJailBroken clientSDKVersion}]','DefaultSecurityHandlerPlugin','')

getSecurityHandlerPlugins

getSecurityHandlerPlugins

説明

SecurityHandlerPluginを取得します。

構文

getSecurityHandlerPlugins()

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

例

getSecurityHandlerPlugins()

次に、サンプル出力を示します。

SecurityHandlerPlugin: JunitDebugSecurityHandlerPluginSecurityHandlerPlugin: OaamSecurityHandlerPluginSecurityHandlerPlugin: DefaultSecurityHandlerPlugin

removeSecurityHandlerPlugin

removeSecurityHandlerPlugin

説明

SecurityHandlerPluginを削除します。

構文

removeSecurityHandlerPlugin(name)

ここで、nameは、削除するSecurityHandlerPluginの名前です。

例

removeSecurityHandlerPlugin('name')

displaySecurityHandlerPlugin

displaySecurityHandlerPlugin

説明

SecurityHandlerPluginを表示します。

構文

displaySecrityHandlerPlugin(name)

ここで、nameは、表示するSecurityHandlerPluginの名前です。

例

displaySecurityHandlerPlugin('name')

createJailBreakingDetectionPolicy

createJailBreakingDetectionPolicy

説明

JailBreakingDetectionPolicyを作成します。

構文

createJailBreakingDetectionPolicy(enabled, statementList, name)

表4-28 createJailBreakingDetectionPolicyの引数

引数	定義
enabled	有効にします。
statementList	パラメータのリスト。
name	JailBreakingDetectionPolicyの名前。

例

createJailBreakingDetectionPolicy(true,'[{minOSVersion:3.5,maxOSVersion:5.0,minClientSDKVersion:1.0,maxClientSDKVersion:1.0,policyExpirationDurationInSec:3600,autoCheckPeriodInMin:60,detectionLocation:[{filePath:"/root",success:true,action:exists},{filePath:"/opt",success:true,action:exists}]}]','defaultJailBreakingDetectionPolicy')

updateJailBreakingDetectionPolicy

updateJailBreakingDetectionPolicy

説明

JailBreakingDetectionPolicyを更新します。

構文

updateJailBreakingDetectionPolicy(enabled, statementList, name)

表4-29 updateJailBreakingDetectionPolicyの引数

引数	定義
enabled	有効にします。
statementList	パラメータのリスト。
name	JailBreakingDetectionPolicyの名前。

例

updateJailBreakingDetectionPolicy(true,'[{minOSVersion:3.5,maxOSVersion:5.0,minClientSDKVersion:1.0,maxClientSDKVersion:1.0,policyExpirationDurationInSec:3600,autoCheckPeriodInMin:60,detectionLocation:[{filePath:"/root",success:true,action:exists},{filePath:"/opt",success:true,action:exists}]}]','defaultJailBreakingDetectionPolicy')

getJailBreakingDetectionPolicys

getJailBreakingDetectionPolicys

説明

JailBreakingDetectionPolicyを取得します。

構文

getJailBreakingDetectionPolicys()

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

例

getJailBreakingDetectionPolicys()

次に、サンプル出力を示します。

JailBreakingDetectionPolicy: DefaultJailBreakingDetectionPolicy

removeJailBreakingDetectionPolicy

removeJailBreakingDetectionPolicy

説明

JailBreakingDetectionPolicyを削除します。

構文

removeJailBreakingDetectionPolicy(name)

ここで、nameは、JailBreakingDetectionPolicyの名前です。

例

removeJailBreakingDetectionPolicy('name')

displayJailBreakingDetectionPolicy

displayJailBreakingDetectionPolicy

説明

JailBreakingDetectionPolicyを表示します。

構文

displayJailBreakingDetectionPolicy(name)

ここで、nameは、JailBreakingDetectionPolicyの名前です。

例

displayJailBreakingDetectionPolicy('DefaultJailBreakingDetectionPolicy')

次に、サンプル出力を示します。

Displaying: JailBreakingDetectionPolicy : DefaultJailBreakingDetectionPolicy
ReadOnly = 0
ConfigMBean = 1
Name = DefaultJailBreakingDetectionPolicy
eventProvider = 1
SystemMBean = 0
objectName = com.oracle.idaas:name=DefaultJailBreakingDetectionPolicy,type=Xml.JailBreakingDetectionPolicy,Xml=MobileService
Enable = 1
JailBreakingDetectionPolicyStatement =
array(javax.management.openmbean.CompositeData,[javax.management.openmbean.
CompositeDataSupport(compositeType=javax.management.openmbean.CompositeType(name=
com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0.
TJailBreakingDetectionPolicyStatement,items=((itemName=autoCheckPeriodInMin,
itemType=javax.management.openmbean.SimpleType(name=java.lang.Long)),
(itemName=detectionLocation,itemType=javax.management.openmbean.ArrayType(name=
[Ljavax.management.openmbean.CompositeData;,dimension=1,elementType=
javax.management.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.
idaas_config_11_1_2_0_0.
TDetectionLocation,items=((itemName=action,itemType=javax.management.openmbean.
SimpleType(name=java.lang.String)),(itemName=filePath,itemType=javax.management.
openmbean.SimpleType(name=java.lang.String)),(itemName=success,itemType=javax.
management.openmbean.SimpleType(name=java.lang.Boolean)))),primitiveArray=false)),
(itemName=enable,itemType=javax.management.openmbean.SimpleType(name=java.lang.
Boolean)),(itemName=maxClientSDKVersion,itemType=javax.management.openmbean.
SimpleType(name=java.lang.String)),(itemName=maxOSVersion,itemType=javax.
management.openmbean.SimpleType(name=java.lang.String)),(itemName=
minClientSDKVersion,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)),
(itemName=minOSVersion,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)),(itemName=policyExpirationDurationInSec,itemType=javax.
management.openmbean.SimpleType(name=java.lang.Long)))),contents=
{autoCheckPeriodInMin=60,detectionLocation=[Ljavax.management.openmbean.
CompositeData;@2dc906,enable=true,maxClientSDKVersion=11.1.2.0.0,
maxOSVersion=null, minClientSDKVersion=11.1.2.0.0, minOSVersion=1.0,
policyExpirationDurationInSec=3600})])
eventTypes = array(java.lang.String,['jmx.attribute.change'])
RestartNeeded = 0

Oracle Access Managementセキュリティ・トークン・サービス

表4-30では、Oracle Access Managementセキュリティ・トークン・サービス(セキュリティ・トークン・サービス)で使用可能な、様々なタイプのWLSTコマンドについて説明します。

表4-30 WLSTセキュリティ・トークン・サービス・コマンド・グループ

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-31に示されているWLSTコマンドを使用して、セキュリティ・トークン・サービスを管理します。

表4-31 WLSTコマンド・セキュリティ・トークン・サービス

コマンド	用途	WLSTでの使用
パートナ・コマンド
getPartner	パートナおよび出力結果を取得します。	オンライン
getAllRequesterPartners	リクエスタ・パートナの名前を取得します。	オンライン
getAllRelyingPartyPartners	すべてのリライイング・パーティ・パートナの名前を取得します。	オンライン
getAllIssuingAuthorityPartners	すべての発行局パートナの名前を取得します。	オンライン
isPartnerPresent	セキュリティ・トークン・サービスを問い合せて、パートナがパートナ・ストア内に存在しているかどうかを判断します。	オンライン
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	既存の発行テンプレートを削除します。	オンライン オフライン

getPartner

パートナ・エントリを取得し、そのパートナの構成を出力するオンライン・コマンド。

説明

パートナ・エントリを取得し、そのパートナの構成を出力します。

構文

getPartner(partnerId)

引数	定義
partnerId	partnerId(パートナのID)を指定します。

例

次の呼出しは、パートナ・エントリを取得し、customPartnerの構成を出力します。

getPartner(partnerId="customPartner")

getAllRequesterPartners

リクエスタ・タイプのパートナを取得するオンライン・コマンド。

説明

リクエスタ・タイプのパートナを取得します。

構文

getAllRequesterPartners()

例

次の呼出しは、リクエスタ・タイプのパートナを取得します。

getAllRequesterPartners()

getAllRelyingPartyPartners

リライイング・パーティ・パートナを取得するオンライン・コマンド。

説明

リライイング・パーティ・パートナを取得します。

構文

getAllRelyingPartyPartners()

例

次の呼出しは、リライイング・パーティ・パートナを取得します。

getAllRelyingPartyPartners()

getAllIssuingAuthorityPartners

発行局パートナを取得し、結果を出力するオンライン・コマンド。

説明

発行局パートナを取得し、結果を出力します。

構文

getAllIssuingAuthorityPartners()

例

次の呼出しは、発行局パートナを取得し、その結果を出力します。

getAllIssuingAuthorityPartners()

isPartnerPresent

セキュリティ・トークン・サービスを問い合せて、指定されたパートナがパートナ・ストア内に存在しているかどうかを判断するオンライン・コマンド。

説明

セキュリティ・トークン・サービスを問い合せて、指定されたパートナがパートナ・ストア内に存在しているかどうかを判断し、結果を出力します。

構文

isPartnerPresent(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

例

次の呼出しは、セキュリティ・トークン・サービスを問い合せて、customPartnerがパートナ・ストア内に存在しているかどうかを判断し、結果を出力します。

isPartnerPresent(partnerId="customPartner")

createPartner

新しいパートナ・エントリを作成するオンライン・コマンド。

説明

提供された情報に基づいて新しいパートナ・エントリを作成します。操作の結果を示すメッセージを表示します。

構文

createPartner(partnerId, partnerType, partnerProfileId, description,
bIsTrusted)

引数	定義
partnerId	作成する新しいパートナのIDを指定します。
partnerType	パートナのタイプを指定します。値として、次のいずれかを指定できます。 リクエスタの場合は、STS_REQUESTER リライイング・パーティの場合は、STS_RELYING_PARTY 発行局の場合は、STS_ISSUING_AUTHORITY
partnerProfileId	このパートナに付加するプロファイルIDを指定します。これは、既存のパートナ・プロファイルを参照する必要があります。そのパートナ・プロファイルのタイプは、新しいパートナ・エントリのタイプに従う必要があります。
description	この新しいパートナ・エントリの説明(オプション)を指定します。
bIsTrusted	この新しいパートナを信頼するかどうかを示す値。値は次のいずれかです。 信頼する場合は、true 信頼しない場合は、false

例

次の呼出しは、STS_Requestorパートナ(customPartner, custom-partnerprofile、説明はcustom requester、信頼の値はtrue)を作成し、操作の結果を示すメッセージを表示します。

createPartner(partnerId="customPartner", partnerType="STS_REQUESTER",
partnerProfileId="custom-partnerprofile", description="custom requester",
bIsTrusted="true")

updatePartner

既存のパートナ・エントリを更新するオンライン・コマンド。

説明

提供された情報に基づいて既存のパートナ・エントリを更新します。操作の結果を示すメッセージを表示します。

構文

updatePartner(partnerId, partnerProfileId, description, bIsTrusted)

引数	定義
partnerId	更新する新しいパートナのIDを指定します。
partnerProfileId	パートナ・プロファイルIDを指定します。これは、既存のパートナ・プロファイルを参照する必要があります。そのパートナ・プロファイルのタイプは、新しいパートナ・エントリのタイプに従う必要があります。
description	この新しいパートナ・エントリの説明(オプション)を指定します。
bIsTrusted	この新しいパートナを信頼するかどうかを示す値。値は次のいずれかです。 信頼する場合は、true 信頼しない場合は、false

例

次の呼出しは、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")

deletePartner

セキュリティ・トークン・サービスからパートナ・エントリを削除するオンライン・コマンド。

説明

セキュリティ・トークン・サービスから、partnerIdパラメータによって参照される既存のパートナ・エントリを削除し、操作の結果を出力します。

構文

deletePartner(partnerId)

引数	定義
partnerId	削除するパートナのIDを指定します。

例

次の呼出しは、セキュリティ・トークン・サービスから、partnerIdパラメータによって参照されるcustomPartnerパートナ・エントリを削除し、操作の結果を出力します。

deletePartner(partnerId="customPartner")

getPartnerUsernameTokenUsername

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのユーザー名値を取得するオンライン・コマンド。

説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのユーザー名値を取得し、値を表示します。

構文

getPartnerUsernameTokenUsername(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

例

次の呼出しは、UNT資格証明パートナ検証またはマッピング操作に使用される、customPartnerパートナ・ユーザー名値を取得し、値を表示します。

getPartnerUsernameTokenUsername(partnerId="customPartner")

getPartnerUsernameTokenPassword

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのパスワード値を取得するオンライン・コマンド。

説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・パスワード値を取得し、値を表示します。

構文

getPartnerUsernameTokenPassword(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

例

次の呼出しは、UNT資格証明パートナ検証またはマッピング操作に使用される、customPartnerパートナ・パスワード値を取得し、値を表示します。

getPartnerUsernameTokenPassword(partnerId="customPartner")

setPartnerUsernameTokenCredential

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・エントリのユーザー名およびパスワード値を設定するオンライン・コマンド。

説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・エントリのユーザー名およびパスワード値を設定します。操作の結果を表示します。

構文

setPartnerUsernameTokenCredential(partnerId, UTUsername, UTPassword)

引数	定義
partnerId	パートナのIDを指定します。
UTUsername	UNT資格証明検証またはマッピング操作に使用されるユーザー名値を指定します。
UTPassword	UNT資格証明検証またはマッピング操作に使用されるユーザー名値を指定します。

例

次の呼出しは、customPartnerパートナ・エントリのユーザー名およびパスワード値を設定し、操作の結果を表示します。

setPartnerUsernameTokenCredential(partnerId="customPartner", UTUsername="test", UTPassword="password")

deletePartnerUsernameTokenCredential

パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示するオンライン・コマンド。

説明

パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。

構文

deletePartnerUsernameTokenCredential(partnerId)

引数	定義
partnerId	削除するパートナのIDを指定します。

例

次の呼出しは、パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。

deletePartnerUsernameTokenCredential(partnerId="customPartner")

getPartnerSigningCert

partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示するオンライン・コマンド。

説明

partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。

構文

getPartnerSigningCert(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

例

次の呼出しは、partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。

getPartnerSigningCert(partnerId="customPartner")

getPartnerEncryptionCert

Base64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示するオンライン・コマンド。

説明

partnerIdパラメータによって参照されるパートナのBase64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。

構文

getPartnerEncryptionCert(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

例

次の呼出しは、partnerIdパラメータによって参照されるパートナのBase64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。

getPartnerEncryptionCert(partnerId="customPartner")

setPartnerSigningCert

提供された証明書を署名証明書としてパートナ・エントリにアップロードするオンライン・コマンド。操作の結果を表示します。

説明

提供された証明書を署名証明書として(partnerIdパラメータによって参照される)パートナ・エントリにアップロードします。サポートされている証明書の形式は、DERおよびPEMです。操作の結果を表示します。

構文

setPartnerSigningCert(partnerId, certFile)

引数	定義
partnerId	パートナのIDを指定します。
certFile	ローカル・ファイル・システム上の証明書の場所を指定します。サポートされている証明書の形式は、DERおよびPEMです。

例

次の呼出しは、提供された証明書を署名証明書としてパートナ・エントリcustomPartnerにアップロードします。操作の結果を表示します。

setPartnerSigningCert(partnerId="customPartner", certFile="/temp/signing_cert")

setPartnerEncryptionCert

提供された証明書を暗号化証明書としてパートナ・エントリにアップロードするオンライン・コマンド。操作の結果を表示します。

説明

提供された証明書を暗号化証明書として(partnerIdパラメータによって参照される)パートナ・エントリにアップロードします。操作の結果を表示します。

構文

setPartnerEncryptionCert(partnerId, certFile)

引数	定義
partnerId	パートナのIDを指定します。
certFile	ローカル・ファイル・システム上の証明書の場所を指定します。サポートされている証明書の形式は、DERおよびPEMです。

例

次の呼出しは、提供された証明書を署名証明書としてパートナ・エントリcustomPartnerにアップロードします。操作の結果を表示します。

setPartnerSigningCert(partnerId="customPartner", certFile="/temp/signing_cert")

deletePartnerSigningCert

パートナ・エントリから暗号化証明書を削除し、操作の結果を表示するオンライン・コマンド。

説明

partnerIdパラメータによって参照されるパートナ・エントリから暗号化証明書を削除し、操作の結果を表示します。

構文

deletePartnerSigningCert(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

例

次の呼出しは、パートナ・エントリcustomPartnerから暗号化証明書を削除し、操作の結果を表示します。

deletePartnerSigningCert(partnerId="customPartner")

deletePartnerEncryptionCert

パートナ・エントリから署名証明書を削除し、操作の結果を表示するオンライン・コマンド。

説明

partnerIdパラメータによって参照されるパートナ・エントリから署名証明書を削除し、操作の結果を表示します。

構文

deletePartnerEncryptionCert(partnerId)

引数	定義
partnerId	パートナのIDを指定します。

例

次の呼出しは、パートナ・エントリcustomPartnerから署名証明書を削除し、操作の結果を表示します。

deletePartnerEncryptionCert(partnerId="customPartner")

getPartnerAllIdentityAttributes

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示するオンライン・コマンド。

説明

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。

アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです。

構文

getPartnerAllIdentityAttributes(partnerId)

引数	定義
partnerId	リクエスタ・パートナのIDを指定します。アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです

例

次の呼出しは、リクエスタ・パートナcustomPartnerにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。

getPartnerAllIdentityAttributes(partnerId="customPartner")

getPartnerIdentityAttribute

リクエスタ・パートナにトークンまたはバインディング・データをマップするために使用されるアイデンティティ・マッピング属性を取得して表示するオンライン・コマンド。

説明

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるアイデンティティ・マッピング属性を取得して表示します。

アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです。

構文

getPartnerIdentityAttribute(partnerId, identityAttributeName)

引数	定義
partnerId	リクエスタ・パートナのIDを指定します。
IdentityAttributeName	取得および表示するアイデンティティ・マッピング属性の名前を指定します。たとえば、httpbasicusernameです。

例

次の呼出しは、identityAttributeNameによって指定されたidentityAttributeとその値を取得して表示します。

getPartnerIdentityAttribute(partnerId="customPartner", identityAttributeName="httpbasicusername")

setPartnerIdentityAttribute

リクエスタ・パートナのアイデンティティ・マッピング属性を設定するオンライン・コマンド。

説明

partnerIdパラメータによって指定されたリクエスタ・タイプのパートナに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を設定します。それらのアイデンティティ・マッピング属性があるのは、リクエスタ・パートナのみです。操作の結果を表示します。

構文

setPartnerIdentityAttribute(partnerId, identityAttributeName, 
identityAttributeValue)

引数	定義
partnerId	リクエスタ・タイプのパートナのIDを指定します。
identityAttributeName	取得および表示するアイデンティティ・マッピング属性の名前を指定します。
identityAttributeValue	設定するアイデンティティ・マッピング属性の値を指定します。

例

次の呼出しは、partnerIdパラメータによって指定されたリクエスタ・タイプのリクエスタ・パートナに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を設定します。操作の結果を表示します。

setPartnerIdentityAttribute(partnerId="customPartner", 
identityAttributeName="httpbasicusername",identityAttributeValue="test")

deletePartnerIdentityAttribute

アイデンティティ・マッピング属性を削除するオンライン・コマンド。

説明

identityAttributeNameによって指定されたアイデンティティ・マッピング属性を削除します。

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるアイデンティティ・マッピング属性。それらの属性があるのは、リクエスタ・パートナのみです。

構文

deletePartnerIdentityAttribute(partnerId, identityAttributeName)

引数	定義
partnerId	パートナのIDを指定します。
identityAttributeName	削除するアイデンティティ・マッピング属性の名前を指定します。

例

次の呼出しは、リクエスタ・パートナcustomPartnerに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を削除します。

deletePartnerIdentityAttribute(partnerId="customPartner", 
identityAttributeName="httpbasicusername")

getAllWSPrefixAndPartnerMappings

リライイング・パーティ・パートナ・マッピングに対するすべてのWS接頭辞を取得して表示するオンライン・コマンド。

説明

リライイング・パーティ・パートナ・マッピングに対するすべてのWS接頭辞を取得して表示します。

構文

getAllWSPrefixAndPartnerMappings() 

例

次の呼出しは、WS接頭辞を取得して表示します。

getAllWSPrefixAndPartnerMappings() 

getWSPrefixAndPartnerMapping

指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示するオンライン・コマンド(そのWS接頭辞に対するマッピングが存在する場合)。

説明

指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。

構文

getWSPrefixAndPartnerMapping(wsprefix) 

引数	定義
wsprefix	取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。 http_protocol://hostname_ip/path

例

次の呼出しは、指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。

getWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path")

createWSPrefixAndPartnerMapping

リライイング・パートナへの新しいWS接頭辞マッピングを作成するオンライン・コマンド。

説明

partneridパラメータによって参照されるリライイング・パートナへの新しいWS接頭辞マッピングを作成し、操作の結果を表示します。

構文

createWSPrefixAndPartnerMapping(wsprefix, partnerid, description)

引数	定義
wsprefix	取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。 http_protocol://hostname_ip/path
partnerId	パートナのIDを指定します。
description	説明を指定します(オプション)。

例

次の呼出しは、partneridパラメータによって参照されるリライイング・パートナへの新しいWS接頭辞マッピングを作成し、操作の結果を表示します。

createWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path",
partnerid="customRPpartner", description="some description")

deleteWSPrefixAndPartnerMapping

リライイング・パートナへのWS接頭辞の既存のマッピングを削除するオンライン・コマンド。

説明

リライイング・パートナへのWS接頭辞の既存のマッピングを削除し、操作の結果を表示します。

構文

deleteWSPrefixAndPartnerMapping(wsprefix)

引数	定義
wsprefix	取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。 http_protocol://hostname_ip/path

例

次の呼出しは、リライイング・パートナへのWS接頭辞の既存のマッピングを削除し、操作の結果を表示します。

deleteWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path")

getAllPartnerProfiles

既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示するオンライン・コマンド。

説明

既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。

構文

getAllPartnerProfiles()

例

次の呼出しは、既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。

getAllPartnerProfiles()

getPartnerProfile

特定のパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示するオンライン・コマンド。

説明

partnerProfileIdパラメータによって参照されるパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。

構文

getPartnerProfile(partnerProfileId)

引数	定義
partnerProfileId	パートナ・プロファイルの名前を指定します。

例

次の呼出しは、partnerProfileIdパラメータによって参照されるパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。

getPartnerProfile(partnerProfileId="custom-partnerprofile")

createRequesterPartnerProfile

デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成し、操作の結果を表示します。

表4-32では、このコマンドで作成されるデフォルト構成について説明します。

表4-32 デフォルト構成: 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表は、デフォルトでは空です。

構文

createRequesterPartnerProfile(partnerProfileId, defaultRelyingPartyPPID, 
description)

引数	定義
partnerProfileId	パートナ・プロファイルの名前を指定します。
defaultRelyingPartyPPID	RSTにAppliesToフィールドがない場合、またはAppliesToフィールドをリライイング・パーティ・パートナにマップできない場合に使用するリライイング・パーティ・パートナ・プロファイルを指定します。
description	このパートナ・プロファイルの説明(オプション)を指定します

例

次の呼出しは、デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成し、操作の結果を表示します。デフォルト・データの説明については、表4-32を参照してください。

createRequesterPartnerProfile(partnerProfileId="custom-partnerprofile",
defaultRelyingPartyPPID="rpPartnerProfileTest", description="custom
partner profile")

createRelyingPartyPartnerProfile

デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成し、操作の結果を表示します。

表4-33では、このコマンドで作成されるデフォルト構成について説明します。

表4-33 デフォルト構成: createRelyingPartyPartnerProfile

要素	説明
ポリシーのダウンロード	デフォルト: false
マップされていない要求を許可	デフォルト: false
トークン・タイプ構成	「トークン・タイプ構成」には、次のような単一のエントリが含まれます。 トークン・タイプが、defaultIssuanceTemplateIDによって参照される発行テンプレートのタイプに設定されている 発行テンプレートがdefaultIssuanceTemplateIDに設定されている 注意: defaultIssuanceTemplateIDによって参照される発行テンプレートのトークン・タイプは、発行テンプレートにリンクされますが、他のトークン・タイプは、どの発行テンプレートにもリンクされません。 defaultIssuanceTemplateIDによって参照される発行テンプレートがカスタム・トークン・タイプの発行テンプレートである場合、表には、外部URIとしてカスタム・トークン・タイプにマップされ、かつdefaultIssuanceTemplateIDによって参照される発行テンプレートにマップされている、カスタム・トークン・タイプの1つのエントリのみが含まれます
属性名マッピング	「属性名マッピング」表は、デフォルトでは空です。

構文

createRelyingPartyPartnerProfile(partnerProfileId, defaultIssuanceTemplateID, 
description)

引数	定義
partnerProfileId	パートナ・プロファイルの名前を指定します。
defaultIssuanceTemplateID	RSTにトークン・タイプが指定されてない場合に発行される、デフォルトの発行テンプレートおよびトークン・タイプを指定します。
description	このパートナ・プロファイルの説明(オプション)を指定します

例

次の呼出しは、デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成し、操作の結果を表示します。

createRelyingPartyPartnerProfile(partnerProfileId="custom-partnerprofile",
defaultIssuanceTemplateID="saml11-issuance-template", description="custom partner profile")

createIssuingAuthorityPartnerProfile

デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成するオンライン・コマンド。

説明

表4-34のデフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成し、操作の結果を表示します。

表4-34 デフォルト構成: 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、空のデータストア列
属性マッピング	「属性値マッピング」および「属性名マッピング」表は、デフォルトでは空です。

構文

createIssuingAuthorityPartnerProfile(partnerProfileId, description)

引数	定義
partnerProfileId	パートナ・プロファイルの名前を指定します。
description	このパートナ・プロファイルの説明(オプション)を指定します

例

次の呼出しは、デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成し、操作の結果を表示します。

createIssuingAuthorityPartnerProfile(partnerProfileId="custom-partnerprofile"
description="custom partner profile")

deletePartnerProfile

partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除するオンライン・コマンド。

説明

partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除し、操作の結果を表示します。

構文

deletePartnerProfile(partnerProfileId) 

引数	定義
partnerProfileId	削除するパートナ・プロファイルの名前を指定します。

例

次の呼出しは、partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除し、操作の結果を表示します。

deletePartnerProfile(partnerProfileId="custom-partnerprofile")

getAllIssuanceTemplates

既存のすべての発行テンプレートの名前を取得するオンライン・コマンド。

説明

既存のすべての発行テンプレートの名前を取得し、それらを表示します。

構文

getAllIssuanceTemplates 

例

次の呼出しは、既存のすべての発行テンプレートの名前を取得し、それらを表示します。

getAllIssuanceTemplates

getIssuanceTemplate

特定の発行テンプレートの構成データを取得するオンライン・コマンド。

説明

issuanceTemplateIdパラメータによって参照される発行テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

構文

getIssuanceTemplate(issuanceTemplateId) 

引数	定義
issuanceTemplateId	発行テンプレートの名前を指定します。

例

次の呼出しは、issuanceTemplateIdパラメータによって参照される発行テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

getIssuanceTemplate(issuanceTemplateId="custom-issuancetemp")

createIssuanceTemplate

デフォルトの構成データを使用して新しい発行テンプレートを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しい発行テンプレートを作成し、操作の結果を表示します。

表4-35では、このコマンドのデフォルト構成について説明します。

表4-35 デフォルト構成: createIssuanceTemplate

トークン・タイプ	説明
ユーザー名	発行テンプレートは、次のデフォルト値を使用して作成されます。 暗号化されたトークンの送信: false 名前IDユーザー属性: uid 名前IDユーザー属性ストア: ユーザー・ストア パスワード属性: (空) Nonceを含める: true タイムスタンプを含める: true
SAML 1.1 または SAML 2.0	発行テンプレートは、次のデフォルト値を使用して作成されます。 暗号化されたトークンの送信: false アサーション発行者: Access Managerホスト名 名前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

構文

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	説明(オプション)。

例

次の呼出しは、デフォルトの構成データを使用して新しい発行テンプレートを作成し、操作の結果を表示します。

createIssuanceTemplate(issuanceTemplateId="custom-issuancetemp", tokenType="saml20", signingKeyId="osts_signing", description="custom issuance template")

deleteIssuanceTemplate

issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示するオンライン・コマンド。

説明

issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。

構文

deleteIssuanceTemplate(issuanceTemplateId) 

引数	定義
issuanceTemplateId	削除する既存の発行テンプレートの名前を指定します。

例

次の呼出しは、issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。

deleteIssuanceTemplate(issuanceTemplateId="custom-issuancetemp")

getAllValidationTemplates

既存のすべての検証テンプレートの名前を取得するオンライン・コマンド。

説明

既存のすべての検証テンプレートの名前を取得し、それらを表示します。

構文

getAllValidationTemplates() 

例

次の呼出しは、既存のすべての検証テンプレートの名前を取得し、それらを表示します。

getAllValidationTemplates()

getValidationTemplate

特定の検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示するオンライン・コマンド。

説明

validationTemplateIdパラメータによって参照される検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

構文

getValidationTemplate(validationTemplateId) 

引数	定義
validationTemplateId	既存の検証テンプレートの名前を指定します。

例

次の呼出しは、特定の検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

getValidationTemplate(validationTemplateId="custom-wss-validtemp")

createWSSValidationTemplate

デフォルトの構成データを使用して新しい検証テンプレートを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しいWSS検証テンプレートを作成し、操作の結果を表示します。検証テンプレートは、トークン・タイプに応じて表4-36の値を使用して作成されます。

表4-36 デフォルト構成: 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

構文

createWSSValidationTemplate(templateId, tokenType,
defaultRequesterPPID, description)

引数	定義
templateId	作成する検証テンプレートの名前を指定します。
tokenType	検証テンプレートのトークン・タイプを指定します。指定できる値は次のとおりです: username: トークン・タイプがUsernameTokenであることを示します saml11: トークン・タイプがSAML 1.1アサーションであることを示します saml20: トークン・タイプがSAML 2.0アサーションであることを示します x509: トークン・タイプがX.509証明書であることを示します kerberos: トークン・タイプがKerberosトークンであることを示します oam: トークン・タイプがAccess Managerであることを示します
defaultRequesterPPID	OSTSが着信メッセージをリクエスタにマップしないように構成されている場合に使用するリクエスタ・パートナ・プロファイルを指定します。
description	説明を指定します(オプション)。

例

次の呼出しは、デフォルトの構成データを使用して新しい検証テンプレートを作成し、操作の結果を表示します。

createWSSValidationTemplate(templateId="custom-wss-validtemp", tokenType="custom",
defaultRequesterPPID="requesterPartnerProfileTest", description="custom validation 
template")

createWSTrustValidationTemplate

デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成し、操作の結果を表示します。WS-Trust検証テンプレートは、トークン・タイプに応じて表4-37の値を使用して作成されます。

表4-37 デフォルト構成: 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 属性ベース・ユーザー・マッピング(空) ユーザー・トークン属性: (空) ユーザー・データストア属性: (空)

構文

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: トークン・タイプが(デフォルトでサポートされている)Access Managerトークンであることを示します <other>: この場合、トークン・タイプは、カスタム・トークン・タイプであると想定され、<other>によって参照されます(<other>は値で置換します)。
description	説明を指定します(オプション)。

例

次の呼出しは、デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成し、操作の結果を表示します。

createWSTrustValidationTemplate(templateId="custom-wss-validtemp", 
tokenType="custom", description="custom validation template")

deleteValidationTemplate

検証テンプレートを削除するオンライン・コマンド。

説明

validationTemplateIdパラメータによって参照される検証テンプレートを削除し、操作の結果を表示します。

構文

deleteValidationTemplate(validationTemplateId)

引数	定義
validationTemplateId	削除する検証テンプレートの名前を指定します。

例

次の呼出しは、validationTemplateIdパラメータによって参照される検証テンプレートを削除し、操作の結果を表示します。

deleteValidationTemplate(validationTemplateId="custom-wss-validtemp") 

Oracleキーストア・サービス

この項では、OPSSキーストア・サービスで使用されるコマンドについて説明します。

注意: キーストア・サービス・コマンドを使用するには、OPSSハンドルを取得する必要があります。詳細は、Oracle Fusion Middlewareセキュリティ・ガイドのキーストア・サービスでのキーと証明書の管理に関する項を参照してください。

表4-38では、キーストア・サービスを管理するために使用されるWLSTコマンドを示します。

表4-38 OPSSキーストア・サービス・コマンド

コマンド	用途
changeKeyPassword	キーのパスワードを変更します。
changeKeyStorePassword	キーストアのパスワードを変更します。
createKeyStore	キーストアを作成します。
deleteKeyStore	キーストアを削除します。
deleteKeyStoreEntry	キーストア内のエントリを削除します。
exportKeyStore	キーストアをファイルにエクスポートします。
exportKeyStoreCertificate	証明書をファイルにエクスポートします。
exportKeyStoreCertificateRequest	証明書リクエストをファイルにエクスポートします。
generateKeyPair	鍵ペアを生成します。
generateSecretKey	秘密鍵を生成します。
getKeyStoreCertificates	証明書または信頼できる証明書に関する情報を取得します。
getKeyStoreSecretKeyProperties	秘密鍵プロパティを取得します。
importKeyStore	ファイルからキーストアをインポートします。
importKeyStoreCertificate	証明書または他のオブジェクトをインポートします。
listExpiringCertificates	指定された期間内に期限切れとなる証明書を一覧表示します。
listKeyStoreAliases	キーストア内の別名を一覧表示します。
listKeyStores	ストライプ内のすべてのキーストアを一覧表示します。

changeKeyPassword

キーのパスワードを変更します。

説明

キーのパスワードを変更します。

構文

svc.changeKeyPassword(appStripe='stripe', name='keystore', password='password', 
alias='alias', currentkeypassword='currentkeypassword', 
newkeypassword='newkeypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを含むストライプの名前を指定します
name	キーストアの名前を指定します
password	キーストアのパスワードを指定します
alias	パスワードを変更するキー・エントリの別名を指定します
currentkeypassword	キーの現在のパスワードを指定します
newkeypassword	キーの新しいパスワードを指定します

例

この例では、キー・エントリorakeyのパスワードを変更します。

svc.changeKeyPassword(appStripe='system', name='keystore', password='password', 
alias='orakey', currentkeypassword='currentkeypassword', 
newkeypassword='newkeypassword')

changeKeyStorePassword

キーストアのパスワードを変更します。

説明

指定されたキーストアのパスワードを変更します。

構文

svc.changeKeyStorePassword(appStripe='stripe', name='keystore', currentpassword='currentpassword', newpassword='newpassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを含むストライプの名前を指定します
name	キーストアの名前を指定します
currentpassword	キーストアの現在のパスワードを指定します
newpassword	キーストアの新しいパスワードを指定します

例

この例では、keystore2のパスワードを変更します。

svc.changeKeyStorePassword(appStripe='system', name='keystore2', 
currentpassword='currentpassword', newpassword='newpassword')

createKeyStore

このキーストア・サービス・コマンドは、新しいキーストアを作成します。

説明

指定されたアプリケーション・ストライプに新しいキーストアを作成します。

構文

svc.createKeyStore(appStripe='stripe', name='keystore', password='password',permission=true|false)

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが作成されるストライプの名前を指定します。
name	新しいキーストアの名前を指定します。
password	キーストアのパスワードを指定します。
permission	キーストアがパーミッションによってのみ保護される場合、このパラメータはtrueです。パーミッションとパスワードの両方によって保護される場合はfalseです。

例

この例では、keystore1という名前のキーストアを作成します。

svc.createKeyStore(appStripe='system', name='keystore1', password='password', permission=true)

deleteKeyStore

指定されたキーストアを削除します。

説明

このキーストア・サービス・コマンドは、指定されたキーストアを削除します。

構文

svc.deleteKeyStore(appStripe='stripe', name='keystore', password='password')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	削除するキーストアの名前を指定します。
password	キーストアのパスワードを指定します。

例

この例では、keystore1という名前のキーストアを削除します。

svc.deleteKeyStore(appStripe='system', name='keystore1', password='password')

deleteKeyStoreEntry

キーストア・エントリを削除します。

説明

このコマンドは、キーストア内の指定されたエントリを削除します。

構文

svc.deleteKeyStoreEntry(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	削除するエントリの別名を指定します
keypassword	削除するエントリのキー・パスワードを指定します

例

この例では、別名orakeyで表されるキーストア・エントリを削除します。

svc.deleteKeyStoreEntry(appStripe='system', name='keystore2', password='password', alias='orakey', keypassword='keypassword')

exportKeyStore

キーストアをファイルにエクスポートします。

説明

指定されたファイルにキーストアをエクスポートします。

構文

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	キーストアのエクスポート先となるファイルの絶対パス。

例

この例では、指定されたキーストアから2つの別名をエクスポートします。

svc.exportKeyStore(appStripe='system', name='keystore2', 
password='password',aliases='orakey,seckey', 
keypasswords='keypassword1,keypassword2', 
type='JKS',filepath='/tmp/file.jks')

exportKeyStoreCertificate

証明書をエクスポートします。

説明

証明書、信頼できる証明書または証明書チェーンをエクスポートします。

構文

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	証明書、信頼できる証明書または証明書チェーンのエクスポート先となるファイルの絶対パスを指定します。

例

この例では、別名orakeyに対応する証明書をエクスポートします。

svc.exportKeyStoreCertificate(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
type='Certificate', filepath='/tmp/cert.txt')

exportKeyStoreCertificateRequest

証明書リクエストをエクスポートします。

説明

証明書リクエストを生成し、キーストアからエクスポートします。

構文

svc.exportKeyStoreCertificateRequest(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword', 
filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	エントリの別名を指定します。
keypassword	キー・パスワードを指定します。
filepath	証明書リクエストのエクスポート先となるファイルの絶対パスを指定します。

例

この例では、別名orakeyに対応する証明書リクエストをエクスポートします。

svc.exportKeyStoreCertificateRequest(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
filepath='/tmp/certreq.txt')

generateKeyPair

キーストアに鍵ペアを生成します。

説明

キーストアに鍵ペアを生成し、デモCA署名証明書にラップします。

構文

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	キー・パスワードを指定します。

例

この例では、keystore2に鍵ペアを生成します。

svc.generateKeyPair(appStripe='system', name='keystore2', password='password', dn='cn=www.oracle.com', keysize='1024', alias='orakey', keypassword='keypassword')

generateSecretKey

秘密鍵を生成します。

説明

キーストアに対称鍵を生成します。

構文

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	キー・パスワードを指定します。

例

この例では、keystore2にキー・サイズ128の鍵ペアを生成します。

svc.generateSecretKey(appStripe='system', name='keystore2', password='password', 
algorithm='AES', keysize='128', alias='seckey', keypassword='keypassword')

getKeyStoreCertificates

キーストアから証明書を取得します。

説明

証明書または信頼できる証明書に関する情報を取得します。

構文

svc.getKeyStoreCertificates(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	表示する証明書、信頼できる証明書または証明書チェーンの別名を指定します。
keypassword	キー・パスワードを指定します。

例

この例では、keystore3に関連付けられている証明書を取得します。

svc.getKeyStoreCertificates(appStripe='system', name='keystore3', password='password', alias='orakey', keypassword='keypassword')

getKeyStoreSecretKeyProperties

秘密鍵のプロパティを取得します。

説明

アルゴリズムなどの秘密鍵のプロパティを取得します。

構文

svc.getKeyStoreSecretKeyProperties(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	プロパティを表示する秘密鍵の別名を指定します。
keypassword	秘密鍵のパスワードを指定します。

例

この例では、秘密鍵seckeyのプロパティを取得します。

svc.getKeyStoreSecretKeyProperties(appStripe='system', name='keystore3', 
password='password', alias='seckey', keypassword='keypassword')

importKeyStore

ファイルからキーストアをインポートします。

説明

システム・ファイルからキーストアをインポートします。

構文

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を指定します。

例

この例では、keystore2にファイルをインポートします。

svc.importKeyStore(appStripe='system', name='keystore2', 
password='password',aliases='orakey,seckey', keypasswords='keypassword1, 
keypassword2', type='JKS', permission=true, filepath='/tmp/file.jks')

importKeyStoreCertificate

証明書または指定された他のオブジェクトをインポートします。

説明

証明書、信頼できる証明書または証明書チェーンをインポートします。

構文

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	証明書、信頼できる証明書または証明書チェーンのインポート元となるファイルの絶対パスを指定します。

例

この例では、keystore2に証明書をインポートします。

svc.importKeyStoreCertificate(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
type='Certificate', filepath='/tmp/cert.txt')

listExpiringCertificates

期限切れになる証明書を一覧表示します。

説明

期限切れになる証明書を一覧表示し、オプションでそれらの期限を更新します。

構文

svc.listExpiringCertificates(days='days', autorenew=true|false)

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
days	日数を指定します。リストには、指定された日数内に期限切れとなる証明書のみが含まれます。
autorenew	期限切れとなる証明書を自動的に更新する場合はtrue、それらを一覧表示するのみの場合はfalseを指定します。

例

この例では、1年以内に期限切れとなる証明書を一覧表示し、それらの更新を要求します。

svc.listExpiringCertificates(days='365', autorenew=true)

listKeyStoreAliases

キーストア内の別名を一覧表示します。

説明

キーストア内の、指定されたエントリ・タイプの別名を一覧表示します。

構文

構文は次のとおりです:

svc.listKeyStoreAliases(appStripe='stripe', name='keystore', 
password='password', type='entrytype')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
type	別名を一覧表示するエントリのタイプを指定します。有効な値は、Certificate、TrustedCertificate、SecretKeyまたは*です。

例

この例では、keystore2内の秘密鍵を一覧表示します。

svc.listKeyStoreAliases(appStripe='system', name='keystore2', 
password='password', type='SecretKey')

listKeyStores

ストライプ内のすべてのキーストアを一覧表示します。

説明

指定されたストライプ内のすべてのキーストアを一覧表示します。

構文

svc.listKeyStores(appStripe='stripe')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを一覧表示するストライプの名前を指定します。

例

この例では、すべてのストライプ上のすべてのキーストアを一覧表示します。

svc.listKeyStores(appStripe='*')

アイデンティティ・ディレクトリ・サービス・コマンド

表4-39に示されているWLSTコマンドを使用して、アイデンティティ・ディレクトリ・サービス・エンティティ属性、エンティティ定義、関係およびデフォルトの操作構成を管理します。

表4-39 WLSTアイデンティティ・ディレクトリ・サービス・コマンド

コマンド	用途	WLSTでの使用
activateIDSConfigChanges	アイデンティティ・ディレクトリ・サービス構成を再ロードします	オンライン
addAttributeInEntityConfig	エンティティ構成に新しい属性を追加します	オンライン
addAttributeRefForEntity	指定されたエンティティに新しい属性を追加します	オンライン
addEntity	エンティティ構成に新しいエンティティを追加します	オンライン
addEntityRelation	エンティティ構成に新しいエンティティ関係を追加します	オンライン
addIdentityDirectoryService	構成に新しいアイデンティティ・ディレクトリ・サービスを追加します	オンライン
addOperationConfig	エンティティ構成に新しい操作構成を追加します	オンライン
addPropertyForOperationConfig	指定された操作構成に新しいプロパティを追加します	オンライン
deleteAttributeInEntityConfig	エンティティ構成から属性を削除します	オンライン
deleteEntity	エンティティ構成からエンティティを削除します	オンライン
deleteEntityRelation	指定されたエンティティ関係を削除します	オンライン
deleteIdentityDirectoryService	構成内の指定されたアイデンティティ・ディレクトリ・サービスを削除します	オンライン
deleteOperationConfig	エンティティ構成内の操作構成を削除します	オンライン
listAllAttributeInEntityConfig	エンティティ構成内のすべての属性を一覧表示します	オンライン
listAllEntityInEntityConfig	指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します	オンライン
listAllIdentityDirectoryService	構成内のアイデンティティ・ディレクトリ・サービスをすべて削除します	オンライン
removeAttributeRefForEntity	指定されたエンティティから属性を削除します	オンライン
removePropertyForOperationConfig	指定された操作構成のプロパティを削除します	オンライン

activateIDSConfigChanges

activateIDSConfigChanges

説明

アイデンティティ・ディレクトリ・サービス構成を再ロードします

構文

activateIDSConfigChanges()

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

例

activateIDSConfigChanges()

addAttributeInEntityConfig

addAttributeInEntityConfig

説明

エンティティ構成に新しい属性を追加します

構文

addAttributeInEntityConfig(name, datatype, description, readOnly, pwdAttr, appName)

表4-40 addAttributeInEntityConfigの引数

引数	定義
name	追加する属性の名前
datatype	属性のタイプは、次のいずれかとして定義されます。 binary boolean datetime double integer rfc822name string x500name
description	追加する属性の説明
readOnly	属性が読取り専用であるか、変更可能であるかを指定するフラグ
pwdAttr	属性でパスワードが定義されるかどうかを指定するフラグ
appName	アイデンティティ・ディレクトリ・サービスの名前

例

addAttributeInEntityConfig('commonname','string','common name',false,false,'userrole')

addAttributeRefForEntity

addAttributeRefForEntity

説明

指定されたエンティティに新しい属性を追加します

構文

addAttributeRefForEntity(name, attrRefName, attrRefFilter, attrRefDefaultFetch, appName)

表4-41 addAttributeRefForEntityの引数

引数	定義
name	属性の追加先となるエンティティの名前
attrRefName	エンティティに追加する属性の名前
attrRefFilter	属性で使用されるフィルタのタイプは、次のいずれかとして定義されます。 beginswith contains doesnotcontain dynamic endswith equals greaterequal greaterthan lessequal lessthan none notequals
attrRefDefaultFetch	属性がデフォルトでフェッチされるかどうかを指定するフラグ
appName	アイデンティティ・ディレクトリ・サービスの名前

例

addAttributeRefForEntity('User','givenname','none','true','userrole')

addEntity

addEntity

説明

エンティティ構成に新しいエンティティを追加します

構文

addEntity(name, type, idAttr, create, modify, delete, search, attrRefNames, attrRefFilters, attrRefDefaultFetches, appName)

表4-42 addEntityの引数

引数	定義
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	アイデンティティ・ディレクトリ・サービスの名前

例

addEntity('Group','group','commonname',true,true,true,true,'name|commonname','none|none','true|false','userrole')

addEntityRelation

addEntityRelation

説明

エンティティ構成に新しいエンティティ関係を追加します

構文

addEntityRelation(name, type, fromEntity, fromAttr, toEntity, toAttr, recursive, appName)

表4-43 addEntityRelationの引数

引数	定義
name	指定された属性のエンティティ間の関係の名前
type	エンティティ関係のタイプ(ManyToMany、ManyToOne、OneToMany、OneToOne)。
fromEntity	関係元となるエンティティの名前
fromAttr	関係元となる属性の名前
toEntity	関係先となるエンティティの名前
toAttr	関係先となる属性の名前
recursive	エンティティ関係を再帰的として設定するフラグ
appName	アイデンティティ・ディレクトリ・サービスの名前

例

addEntityRelation('manager', 'ManyToOne', 'User', 'manager', 'User', 'principal', false, 'userrole')

addIdentityDirectoryService

addIdentityDirectoryService

説明

アイデンティティ・ディレクトリ・サービス構成に新しいIdentityStoreServiceを追加します

構文

addIdentityDirectoryService(name, description, propNames, propValues)

表4-44 addIdentityDirectoryServiceの引数

引数	定義
name	追加するIdentityStoreServiceの名前
description	IdentityStoreServiceの説明
propNames	IdentityStoreService構成に追加するプロパティ名の配列
propValues	IdentityStoreService構成に追加するプロパティ名に対して定義される値の配列

例

addIdentityDirectoryService('userrole', 'user role', 'ovd.context|entity.config', 'default|userrole')

addOperationConfig

addOperationConfig

説明

エンティティ構成に新しい操作構成を追加します

構文

addOperationConfig(entityName, propNames, propValues, appName)

表4-45 addOperationConfigの引数

引数	定義
entityName	操作構成の追加先となるエンティティの名前
propNames	操作構成に追加するプロパティ名の配列
propValues	操作構成に追加するプロパティのプロパティ値の配列
appName	アイデンティティ・ディレクトリ・サービスの名前

例

addOperationConfig('User', 'entity.searchbase', 'cn=users,dc=oracle,dc=com', 'userrole')

addPropertyForOperationConfig

addPropertyForOperationConfig

説明

指定された操作構成に新しいプロパティを追加します

構文

addPropertyForOperationConfig(entityName, propName, propValue, appName)

表4-46 addPropertyForOperationConfigの引数

引数	定義
entityName	操作構成の追加先となるエンティティの名前
propName	操作構成に追加するプロパティ名
propValue	操作構成に追加するプロパティの値
appName	アイデンティティ・ディレクトリ・サービスの名前

例

addPropertyForOperationConfig('User','entity.searchbase', 'cn=users,dc=oracle,dc=com', 'userrole')

deleteAttributeInEntityConfig

deleteAttributeInEntityConfig

説明

エンティティ構成から属性を削除します

構文

deleteAttributeInEntityConfig(name, appName)

表4-47 addPropertyForOperationConfigの引数

引数	定義
name	削除する属性の名前
appName	アイデンティティ・ディレクトリ・サービスの名前

例

deleteAttributeInEntityConfig('commonname', 'userrole')

deleteEntity

deleteEntity

説明

エンティティ構成からエンティティを削除します

構文

deleteEntity(name, appName)

表4-48 deleteEntityの引数

引数	定義
name	削除するエンティティの名前
appName	アイデンティティ・ディレクトリ・サービスの名前

例

deleteEntity('User', 'userrole')

deleteEntityRelation

deleteEntityRelation

説明

指定されたエンティティ関係を削除します

構文

deleteEntityRelation(name, appName)

表4-49 deleteEntityRelationの引数

引数	定義
name	指定された属性のエンティティ間の関係の名前
appName	アイデンティティ・ディレクトリ・サービスの名前

例

deleteEntityRelation('manager', 'userrole')

deleteIdentityDirectoryService

deleteIdentityDirectoryService'

説明

アイデンティティ・ディレクトリ・サービス構成内の指定されたIdentityStoreServiceを削除します

構文

deleteIdentityDirectoryService(name)

ここで、nameは、削除するIdentityStoreService構成の名前です。

例

deleteIdentityDirectoryService('ids1')

deleteOperationConfig

deleteOperationConfig

説明

エンティティ構成内の操作構成を削除します

構文

deleteOperationConfig(entityName, appName)

表4-50 deleteOperationConfigの引数

引数	定義
entityName	操作構成の削除元となるエンティティの名前
appName	アイデンティティ・ディレクトリ・サービスの名前

例

deleteOperationConfig('User','userrole')

listAllAttributeInEntityConfig

listAllAttributeInEntityConfig

説明

エンティティ構成内のすべての属性を一覧表示します

構文

listAllAttributeInEntityConfig(appName)

ここで、appNameは、属性のリストの取得元となるエンティティ構成を含むアイデンティティ・ディレクトリ・サービスの名前です。

例

listAllAttributeInEntityConfig('userrole')

listAllEntityInEntityConfig

listAllEntityInEntityConfig

説明

指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します

構文

listAllEntityInEntityConfig(appName)

ここで、appNameは、エンティティのリストの取得元となるエンティティ構成を含むアイデンティティ・ディレクトリ・サービスの名前です。

例

listAllEntityInEntityConfig('userrole')

listAllIdentityDirectoryService

listAllIdentityDirectoryService

説明

アイデンティティ・ディレクトリ・サービス構成内のすべてのIdentityStoreServiceを一覧表示します

構文

listAllIdentityDirectoryService()

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

例

listAllIdentityDirectoryService()

removeAttributeRefForEntity

removeAttributeRefForEntity

説明

指定されたエンティティから属性を削除します

構文

removeAttributeRefForEntity(name, attrRefName, appName)

表4-51 removeAttributeRefForEntityの引数

引数	定義
name	属性の削除元となるエンティティの名前
attrRefName	削除する属性の名前
appName	アイデンティティ・ディレクトリ・サービスの名前

例

removeAttributeRefForEntity('User','givenname','userrole')

removePropertyForOperationConfig

removePropertyForOperationConfig

説明

指定された操作構成のプロパティを削除します

構文

removePropertyForOperationConfig(entityName, propName, appName)

表4-52 removePropertyForOperationConfigの引数

引数	定義
entityName	操作構成の追加先となるエンティティの名前
propName	操作構成に追加するプロパティ名
appName	アイデンティティ・ディレクトリ・サービスの名前

例

removePropertyForOperationConfig('User','entity.searchbase','userrole')

Oracle Virtual Directoryライブラリ(LibOVD)コマンド

表4-53に示されているWLSTコマンドを使用して、Oracle Virtual Directoryライブラリ(LibOVD) LDAPおよび結合アダプタ構成を管理します。これらのコマンドは、パラメータとして渡される特定のOPSSコンテキストに関連付けられているOVD構成で機能します。

表4-53 WLST LibOVDコマンド

コマンド	用途	WLSTでの使用
activateLibOVDConfigChanges	LibOVD構成を再ロードします	オンライン
addAttributeExclusionRule	属性除外ルールを追加します	オンライン
addAttributeRule	新しい属性マッピング・ルールを追加します	オンライン
addDomainExclusionRule	ドメイン除外ルールを追加します	オンライン
addDomainRule	新しいドメイン・マッピング・ルールを追加します	オンライン
addJoinRule	指定されたOPSSコンテキストに関連付けられているOVDの既存の結合アダプタに結合ルールを追加します	オンライン
addLDAPHost	既存のLDAPアダプタに新しいリモート・ホストを追加します	オンライン
addMappingContext	新しいマッピング・コンテキストを作成します	オンライン
addPlugin	既存のアダプタに、またはグローバル・レベルでプラグインを追加します	オンライン
addPluginParam	既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します	オンライン
createJoinAdapter	指定されたOPSSコンテキストに関連付けられているOVDの新しい結合アダプタを作成します	オンライン
createLDAPAdapter	指定されたOPSSコンテキストに関連付けられているOVDの新しいLDAPアダプタを作成します	オンライン
deleteAdapter	指定されたOPSSコンテキストに関連付けられているOVDの既存のアダプタを削除します	オンライン
deleteAttributeExclusionRule	属性除外ルールを削除します	オンライン
deleteAttributeRule	属性マッピング・ルールを削除します	オンライン
deleteDomainExclusionRule	ドメイン除外ルールを削除します	オンライン
deleteDomainRule	ドメイン・マッピング・ルールを削除します	オンライン
deleteMappingContext	指定されたマッピング・コンテキストを削除します	オンライン
getAdapterDetails	指定されたOPSSコンテキストに関連付けられているOVDに対して構成されている既存のアダプタの詳細を表示します	オンライン
listAdapters	指定されたOPSSコンテキストに関連付けられているこのOVDに対して構成されているすべてのアダプタの名前とタイプを一覧表示します	オンライン
listAllMappingContextIds	すべてのマッピング・コンテキストを一覧表示します	オンライン
listAttributeRules	すべての属性ルールを一覧表示します	オンライン
listDomainRules	すべてのドメイン・ルールを一覧表示します	オンライン
modifyLDAPAdapter	既存のLDAPアダプタ構成を変更します	オンライン
removeJoinRule	指定されたOPSSコンテキストに関連付けられているこのOVDに対して構成されている結合アダプタから結合ルールを削除します	オンライン
removeLDAPHost	既存のLDAPアダプタ構成からリモート・ホストを削除します	オンライン
removePlugin	既存のアダプタから、またはグローバル・レベルでプラグインを削除します	オンライン
removePluginParam	構成済のアダプタ・レベル・プラグインまたはグローバル・プラグインから既存のパラメータを削除します	オンライン

activateLibOVDConfigChanges

activateLibOVDConfigChanges

説明

LibOVD構成を再ロードします。

構文

activateLibOVDConfigChanges(contextName)

ここで、contextNameは、OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前です。このオプションのパラメータのデフォルト値はdefaultです。

例

activateLibOVDConfigChanges('default')

addAttributeExclusionRule

addAttributeExclusionRule

説明

属性除外ルールを追加します。

構文

addAttributeExclusionRule(attribute, mappingContextId, contextName)

表4-54 addAttributeExclusionRuleの引数

引数	定義
attribute	除外リストに追加する属性の名前
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addAttributeExclusionRule('objectsid')

addAttributeRule

addAttributeRule

説明

新しい属性マッピング・ルールを追加します。

構文

addAttributeRule(srcAttrs, srcObjectClass, srcAttrType, dstAttr, dstObjectClass, dstAttrType, mappingExpression, direction, mappingContextId, contextName)

表4-55 addAttributeRuleの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addAttributeRule('lastname','','','sn','','','','Inbound')

addDomainExclusionRule

addDomainExclusionRule

説明

ドメイン除外ルールを追加します。

構文

addDomainExclusionRule(domain, mappingContextId, contextName)

表4-56 addDomainExclusionRuleの引数

引数	定義
domain	除外リストに追加する属性の識別名(DN)
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addDomainExclusionRule('cn=group,dc=oracle,dc=com')

addDomainRule

addDomainRule

説明

新しいドメイン・マッピング・ルールを追加します。

構文

addDomainRule(srcDomain, destDomain, domainConstructRule, mappingContextId, contextName)

表4-57 deleteEntityRelationの引数

引数	定義
srcDomain
destDomain
domainConstructRule	除外リストに追加する属性の名前
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addDomainRule('dc=oracle,dc=com', 'dc=oracle,dc=com', '', 'defaultContext', 'default')

addJoinRule

addJoinRule

説明

指定されたOPSSコンテキストに関連付けられているOVDの既存の結合アダプタに結合ルールを追加します。

構文

addJoinRule(adapterName=<adapterName>, secondary=<secondary>, condition=<condition>, joinerType=<joinerType>, contextName=<contextName>)

表4-58 addJoinRuleの引数

引数	定義
adapterName	変更する結合アダプタの名前
secondary	結合先のアダプタの名前
condition	結合する属性
joinerType	結合のタイプを定義するオプションのパラメータ。許容される値は、Simple(デフォルト)、Conditional、OneToManyまたはShadowです。
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

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

addLDAPHost

addLDAPHost

説明

既存のLDAPアダプタに新しいリモート・ホスト(host:portペア)を追加します。デフォルトでは、新しいホストは、読取り-書込みモード(パーセンテージは100に設定されます)で構成されます。

構文

addLDAPHost(adapterName=<adapterName>, host=<host>, port=<port>, contextName=<contextName>)

表4-59 addLDAPHostの引数

引数	定義
adapterName	変更する結合アダプタの名前
host	LDAPアダプタの通信先となるリモートLDAPホスト
port	リモートLDAPホストのポート
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addLDAPHost(adapterName='ldap1', host='myhost.example.com', port=389)addLDAPHost('ldap1', 'myhost.example.com','389', 'myContext')

addMappingContext

addMappingContext

説明

新しいマッピング・コンテキストを作成します。

構文

addMappingContext(mappingContextId, contextName)

表4-60 addMappingContextの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addMappingContext('defaultContext','context)

addPlugin

addPlugin

説明

既存のアダプタに、またはグローバル・レベルでプラグインを追加します。i番目のキーはi番目の値に対応しています。プラグインは、デフォルト・チェーンに追加されます。

構文

addPlugin(pluginName=<pluginName>, pluginClass=<pluginClass>, paramKeys=<paramKeys>, paramValues=<paramValues>, adapterName=<adapterName>, contextName=<contextName>)

表4-61 addPluginの引数

引数	定義
pluginName	pluginName - 作成するプラグインの名前
pluginClass	プラグインのクラス
paramKeys	|で区切られた初期化パラメータ・キー。
paramValues	|で区切られた初期化パラメータ値。
adapterName	変更するアダプタの名前。指定しない場合、プラグインは、グローバル・レベルで追加されます。
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

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

addPluginParam

addPluginParam

説明

既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します。パラメータがすでに存在している場合、既存の値のセットに新しい値が追加されます。i番目のキーはi番目の値に対応しています。

構文

addPluginParam(pluginName=<pluginName>, paramKeys=<paramKeys>, paramValues=<paramValues>, adapterName=<adapterName>, contextName=<contextName>)

表4-62 addPluginParamの引数

引数	定義
pluginName	pluginName - 変更するプラグインの名前
paramKeys	|で区切られた初期化パラメータ・キー。
paramValues	|で区切られた初期化パラメータ値。
adapterName	変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addPluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', paramValues='cn=%uid% | objectclass=person')addPluginParam(pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', par)

createJoinAdapter

createJoinAdapter

説明

指定されたOPSSコンテキストに関連付けられているOVDの新しい結合アダプタを作成します。

構文

createJoinAdapter(contextName=<contextName>, adapterName=<adapterName>, root=<root>, primaryAdapter=<primaryAdapter>, bindAdapter=<bindAdapter>)

表4-63 createJoinAdapterの引数

引数	定義
adapterName	作成する結合アダプタの名前
mappingContextId	結合アダプタの仮想ネームスペース
primaryAdapter	プライマリ・アダプタ(結合操作で最初に検索されるアダプタ)の識別子を指定します。
root
bindAdapter	バインド・アダプタ(LDAP操作でそのプロキシ・アカウントがバインドに使用されるアダプタ)の識別子を指定します。デフォルトでは、primaryAdapterはbindAdapterに設定されます。
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

createJoinAdapter('join1','dc=join','primaryldap','myldap', 'myContext')createJoinAdapter(adapterName='join1', root='dc=join', primaryAdapter='myldap')

createLDAPAdapter

createLDAPAdapter

説明

指定されたOPSSコンテキストに関連付けられているOVDの新しいLDAPアダプタを作成します。

構文

createLDAPAdapter(adapterName=<adapterName>, root=<root>, host=<host>, port=<port>, remoteBase=<remoteBase>, isSecure=<true|false>, bindDN=<bindDN>, bindPasswd=<bindPasswd>, passCred=<passCred>, contextName=<contextName>)

表4-64 createLDAPAdapterの引数

引数	定義
adapterName	作成するLDAPアダプタの名前
root	LDAPアダプタの仮想ネームスペース
host	LDAPアダプタの通信先となるリモートLDAPホスト
port	リモートLDAPホストのポート番号
remoteBase	ルートが対応するリモートDIT内の場所。
isSecure	trueとして定義された場合、リモート・ホストへのセキュアなSSL/TLS接続を可能にするオプションのパラメータ。デフォルト値はfalseです。
bindDN	リモート・ホストとの通信に使用されるプロキシのBindDN。オプションのパラメータ(デフォルト値は"")。
bindPasswd	リモート・ホストとの通信に使用されるプロキシのBindPasswd。オプションのパラメータ(デフォルト値は"")。
passCred	このオプションのパラメータは、OVDがバックエンド(リモート・ホスト)LDAPサーバーにどのような資格証明を渡すかを制御します(資格証明がある場合)。値として、Always(デフォルト)、NoneまたはBindOnlyを指定できます。
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

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

deleteAdapter

deleteAdapter

説明

指定されたOPSSコンテキストに関連付けられているOVDの既存のアダプタを削除します。

構文

deleteAdapter(adapterName=<adapterName>, contextName=<contextName>)

表4-65 deleteAdapterの引数

引数	定義
adapterName	削除する結合アダプタの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteAdapter(adapterName='join1')deleteAdapter('join1', 'default'))

deleteAttributeExclusionRule

deleteAttributeExlusionRule

説明

Delete an attribute exclusion rule.

構文

deleteAttributeExclusionRule(attribute, mappingContextId, contextName)

表4-66 deleteAttributeExclusionRuleの引数

引数	定義
attribute	除外リストから削除する属性の名前
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteAttributeExclusionRule('objectsid')

deleteAttributeRule

deleteAttributeRule

説明

属性マッピング・ルールを削除します。

構文

deleteAttributeRule(srcAttrs, dstAttr, mappingContextId, contextName)

表4-67 deleteEntityRelationの引数

引数	定義
srcAttrs
dstAttr
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteAttributeRule('lastname','sn')

deleteDomainExclusionRule

deleteDomainExclusionRule

説明

ドメイン除外ルールを削除します。

構文

deleteDomainExclusionRule(domain, mappingContextId, contextName)

表4-68 deleteEntityRelationの引数

引数	定義
domain	除外リストから削除するコンテナの識別名
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteDomainExclusionRule('cn=group,dc=oracle,dc=com')

deleteDomainRule

deleteDomainRule

説明

ドメイン・マッピング・ルールを削除します。

構文

deleteDomainRule(srcDomain, destDomain, mappingContextId, contextName)

表4-69 deleteDomainRuleの引数

引数	定義
srcDomain
destDomain
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteDomainRule('dc=oracle,dc=com','dc=oracle,dc=com')

deleteMappingContext

deleteMappingContext

説明

指定されたマッピング・コンテキストを削除します。

構文

deleteMappingContext(mappingContextId, contextName)

表4-70 deleteMappingContextの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteMappingContext('defaultContext','context)

getAdapterDetails

getAdapterDetails

説明

指定されたOPSSコンテキストに関連付けられているOracle Virtual Directoryに対して構成されている既存のアダプタの詳細を表示します。

構文

getAdapterDetails(adapterName=<adapterName>, contextName=<contextName>)

表4-71 getAdapterDetailsの引数

引数	定義
adapterName	表示する詳細を含むアダプタの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

getAdapterDetails(adapterName='ldap1', contextName='default')getAdapterDetails(adapterName='join1')

listAdapters

listAdapters

説明

指定されたOPSSコンテキストに関連付けられているOracle Virtual Directoryに対して構成されているすべてのアダプタの名前とタイプを一覧表示します。

構文

listAdapters(contextName='contextName')

表4-72 listAdaptersの引数

引数	定義
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

listAdapters()listAdapters(contextName='myContext')

listAllMappingContextIds

listAllMappingContextIds

説明

指定されたOPSSコンテキストに関連付けられているマッピング・コンテキストを一覧表示します。

構文

listAllMappingContextIds(contextName)

表4-73 listAllMappingContextIdsの引数

引数	定義
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

listAllMappingContextIds('default')

listAttributeRules

listAttributeRules

説明

SOURCE_ATTRIBUTE:DESTINATION_ATTRIBUTE:DIRECTIONという形式のすべての属性ルールを一覧表示します。

構文

listAttributeRules(mappingContextId, contextName)

表4-74 listAttributeRulesの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

listAttributeRules('defaultContext','default)

listDomainRules

listDomainRules

説明

SOURCE_DOMAIN:DESTINATION_DOMAINという形式のすべてのドメイン・ルールを一覧表示します。

構文

listDomainRules(mappingContextId, contextName)

表4-75 listDomainRulesの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

listDomainRules('defaultContext','default')

modifyLDAPAdapter

modifyLDAPAdapter

説明

このコマンドは、既存のLDAPアダプタで定義されている次のパラメータを変更するために使用されます。

• リモート・ベース

• ルート

• セキュア

• BindDN

• BindPassword

• PassCredentials

• MaxPoolSize

構文

modifyLDAPAdapter(adapterName=<adapterName>, attribute=<attribute>, value=<value>, contextName=<contextName>)

表4-76 modifyLDAPAdapterの引数

引数	定義
attribute	変更する属性の名前
value	属性の新しい値
adapterName	変更するLDAPアダプタの名前
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

modifyLDAPAdapter(adapterName='ldap1', attribute='Root', value='dc=us, dc=oracle, dc=com', contextName='mydefault')modifyLDAPAdapter(adapterName='ldap1', attribute='RemoteBase', value='dc=org')modifyLDAPAdapter(adapterName='ldap1', attribute='PassCredentials', value='BindOnly')modifyLDAPAdapter('ldap1', 'BindDN', 'cn=proxyuser,dc=com', 'mydefault')modifyLDAPAdapter(adapterName='ldap1', attribute='BindPassword', value='testwelcome123')modifyLDAPAdapter(adapterName='ldap1', attribute='Secure', value=true)modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolSize', value=500)

removeJoinRule

removeJoinRule

説明

指定されたOPSSコンテキストに関連付けられているOracle Virtual Directoryに対して構成されている結合アダプタから結合ルールを削除します。

構文

removeJoinRule(adapterName=<adapterName>, secondary=<secondary>, contextName=<contextName>)

表4-77 removeJoinRuleの引数

引数	定義
adapterName	変更する結合アダプタの名前
secondary	このセカンダリ・アダプタに対応する結合ルールが結合アダプタから削除されます
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

removeJoinRule('join1','secondaryldap1', 'default')removeJoinRule(adapterName='join1', secondary='LDAP3')

removeLDAPHost

removeLDAPHost

説明

既存のLDAPアダプタからリモート・ホスト(host:port)を削除します。

構文

removeLDAPHost(adapterName=<adapterName>, host=<host>, contextName=<contextName>)

表4-78 removeLDAPHostの引数

引数	定義
adapterName	変更するLDAPアダプタの名前
host	LDAPアダプタの通信先となるリモートLDAPホストの場所
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

removeLDAPHost(adapterName='ldap1', host='myhost.example.com')removeLDAPHost('ldap1', 'myhost.example.com', 'myContext')

removePlugin

removePlugin

説明

既存のアダプタから、またはグローバル・レベルでプラグインを削除します。

構文

removePlugin(pluginName=<pluginName>, adapterName=<adapterName>, contextName=<contextName>)

表4-79 removePluginの引数

引数	定義
pluginName	削除するプラグインの名前
adapterName	変更するアダプタの名前。指定しない場合、グローバル・プラグインが削除されます。
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

removePlugin(adapterName='ldap1', pluginName='VirtualAttr')removePlugin(pluginName='VirtualAttr')

removePluginParam

removePluginParam

説明

構成済のアダプタ・レベル・プラグインまたはグローバル・プラグインから既存のパラメータを削除します。このコマンドは、プラグインから特定のパラメータのすべての値を削除します。

構文

removePluginParam(pluginName=<pluginName>, paramKey=<paramKey>, adapterName=<adapterName>, contextName=<contextName>)

表4-80 removePluginParamの引数

引数	定義
pluginName	変更するプラグインの名前
paramKey	削除するパラメータ
adapterName	変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。
contextName	OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

removePluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKey='ReplaceAttribute')removePluginParam(pluginName='VirtualAttr', paramKey='ReplaceAttribute')