5 セキュリティ・トークン・サービスのWLSTコマンド
「セキュリティ・トークン・サービスのコマンド」の項に、セキュリティ・トークン・サービスのWLSTコマンドの一覧をコマンド・リファレンスの詳細へのリンクとともに示します。
5.1 セキュリティ・トークン・サービスのコマンド
これらのWLSTコマンドを使用して、セキュリティ・トークン・サービスを管理します。
セキュリティ・トークン・サービスの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...
-
パートナ・プロファイル・コマンドは、パートナ・プロファイルに関するタスクに関連します。
-
発行テンプレート・コマンド は、発行テンプレートに関するタスクに関連します。
-
検証テンプレート・コマンドは、検証テンプレートに関するタスクに関連します。
表5-1 セキュリティ・トークン・サービスのWLSTコマンド
使用するコマンド | 目的 | WLSTの使用... |
---|---|---|
パートナのコマンド |
||
パートナおよび出力結果を取得します。 |
オンライン |
|
リクエスタ・パートナの名前を取得します。 |
オンライン |
|
すべてのリライイング・パーティ・パートナの名前を取得します。 |
オンライン |
|
すべての発行局パートナの名前を取得します。 |
オンライン |
|
セキュリティ・トークン・サービスを問い合せて、パートナがパートナ・ストア内に存在しているかどうかを判断します。 |
オンライン |
|
新しいパートナ・エントリを作成します。 |
オンライン |
|
提供された情報に基づいて既存のパートナ・エントリを更新します。 |
オンライン |
|
パートナ・エントリを削除します。 |
オンライン |
|
パートナのユーザー名値を取得します。 |
オンライン |
|
パートナのパスワード値を取得します。 |
オンライン |
|
パートナ・エントリのユーザー名およびパスワード値を設定します。 |
オンライン |
|
パートナ・エントリからユーザー名およびパスワード値を削除します。 |
オンライン |
|
パートナのBase64エンコード署名証明書を取得します。 |
オンライン |
|
パートナのBase64エンコード暗号化証明書を取得します。 |
オンライン |
|
パートナ・エントリに署名証明書をアップロードします。 |
オンライン |
|
パートナ・エントリに暗号化証明書をアップロードします。 |
オンライン |
|
パートナ・エントリから署名証明書を削除します。 |
オンライン オフライン |
|
パートナ・エントリから暗号化証明書を削除します。 |
オンライン オフライン |
|
トークンをリクエスタ・パートナにマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。 |
オンライン オフライン |
|
アイデンティティ・マッピング属性を取得して表示します。 |
オンライン オフライン |
|
リクエスタ・パートナのアイデンティティ・マッピング属性を設定します。 |
オンライン オフライン |
|
リクエスタ・パートナのアイデンティティ・マッピング属性を削除します。 |
オンライン オフライン |
|
リライイング・パーティ・パートナ・マッピング・コマンド |
||
すべてのWS接頭辞を取得して表示します。 |
オンライン オフライン |
|
指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します。 |
オンライン オフライン |
|
リライイング・パートナへの新しいWS接頭辞マッピングを作成します。 |
オンライン オフライン |
|
リライイング・パートナへの既存のWS接頭辞マッピングを削除します。 |
オンライン オフライン |
|
パートナ・プロファイルのコマンド |
||
既存のすべてのパートナ・プロファイルの名前を取得します。 |
オンライン |
|
パートナ・プロファイル構成データを取得します。 |
オンライン |
|
デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成します。 |
オンライン |
|
デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成します。 |
オンライン |
|
デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成します。 |
オンライン |
|
既存のパートナ・プロファイルを削除します。 |
オンライン |
|
発行テンプレート・コマンド |
||
既存のすべての発行テンプレートの名前を取得します。 |
オンライン オフライン |
|
特定の発行テンプレートの構成データを取得します。 |
オンライン |
|
デフォルトの構成データを使用して新しい発行テンプレートを作成します。 |
オンライン |
|
既存の発行テンプレートを削除します。 |
オンライン オフライン |
|
検証テンプレート・コマンド |
||
既存のすべての検証テンプレートの名前を取得します。 |
オンライン オフライン |
|
特定の検証テンプレートの構成データを取得します。 |
オンライン オフライン |
|
デフォルトの構成データを使用して新しいWS-Security検証テンプレートを作成します。 |
オンライン オフライン |
|
デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成します。 |
オンライン オフライン |
|
既存の発行テンプレートを削除します。 |
オンライン オフライン |
|
MSAS/OWSMポリシーの機能を許可するように構成を変更します |
オンライン |
5.1.1 getPartner
getPartnerコマンドはオンライン・コマンドで、パートナ・エントリを取得し、このパートナの構成を出力します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
パートナ・エントリを取得し、そのパートナの構成を出力します。
構文
getPartner(partnerId)
引数 | 定義 |
---|---|
partnerId |
partnerId(パートナのID)を指定します。 |
例
次の呼出しは、パートナ・エントリを取得し、customPartner
の構成を出力します。
getPartner(partnerId="customPartner")
5.1.2 getAllRequesterPartners
getAllRequesterPartnersコマンドはオンライン・コマンドで、リクエスタ・タイプのパートナを取得します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
リクエスタ・タイプのパートナを取得します。
構文
getAllRequesterPartners()
例
次の呼出しは、リクエスタ・タイプのパートナを取得します。
getAllRequesterPartners()
5.1.3 getAllRelyingPartyPartners
getAllRelyingPartyPartnersコマンドはオンライン・コマンドで、リライイング・パーティ・パートナを取得します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
リライイング・パーティ・パートナを取得します。
構文
getAllRelyingPartyPartners()
例
次の呼出しは、リライイング・パーティ・パートナを取得します。
getAllRelyingPartyPartners()
5.1.4 getAllIssuingAuthorityPartners
getAllIssuingAuthorityPartnersコマンドはオンライン・コマンドで、発行局パートナを取得し、結果を出力します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
発行局パートナを取得し、結果を出力します。
構文
getAllIssuingAuthorityPartners()
例
次の呼出しは、発行局パートナを取得し、その結果を出力します。
getAllIssuingAuthorityPartners()
5.1.5 isPartnerPresent
isPartnerPresentコマンドは、セキュリティ・トークン・サービスを問い合せて、指定されたパートナがパートナ・ストア内に存在しているかどうかを判断するコマンドです。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
セキュリティ・トークン・サービスを問い合せて、指定されたパートナがパートナ・ストア内に存在しているかどうかを判断し、結果を出力します。
構文
isPartnerPresent(partnerId)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
例
次の呼出しは、セキュリティ・トークン・サービスを問い合せて、customPartner
がパートナ・ストア内に存在しているかどうかを判断し、結果を出力します。
isPartnerPresent(partnerId="customPartner")
5.1.6 createPartner
createPartnerコマンドはオンライン・コマンドで、新しいパートナ・エントリを作成します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
提供された情報に基づいて新しいパートナ・エントリを作成します。操作の結果を示すメッセージを表示します。
構文
createPartner(partnerId, partnerType, partnerProfileId, description, bIsTrusted)
引数 | 定義 |
---|---|
partnerId |
作成する新しいパートナのIDを指定します。 |
partnerType |
パートナのタイプを指定します。値として、次のいずれかを指定できます。
|
partnerProfileId |
このパートナに付加するプロファイルIDを指定します。これは、既存のパートナ・プロファイルを参照する必要があります。そのパートナ・プロファイルのタイプは、新しいパートナ・エントリのタイプに従う必要があります。 |
description |
この新しいパートナ・エントリの説明(オプション)を指定します。 |
bIsTrusted |
この新しいパートナを信頼するかどうかを示す値。値は次のいずれかです。
|
例
次の呼出しは、STS_Requestorパートナ(customPartner, custom-partnerprofile
、説明はcustom requester
、信頼の値はtrue
)を作成し、操作の結果を示すメッセージを表示します。
createPartner(partnerId="customPartner", partnerType="STS_REQUESTER", partnerProfileId="custom-partnerprofile", description="custom requester", bIsTrusted="true")
5.1.7 updatePartner
updatePartnerコマンドはオンライン・コマンドで、既存のパートナ・エントリを更新します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
提供された情報に基づいて既存のパートナ・エントリを更新します。操作の結果を示すメッセージを表示します。
構文
updatePartner(partnerId, partnerProfileId, description, bIsTrusted)
引数 | 定義 |
---|---|
partnerId |
更新する新しいパートナのIDを指定します。 |
partnerProfileId |
パートナ・プロファイルIDを指定します。これは、既存のパートナ・プロファイルを参照する必要があります。そのパートナ・プロファイルのタイプは、新しいパートナ・エントリのタイプに従う必要があります。 |
description |
この新しいパートナ・エントリの説明(オプション)を指定します。 |
bIsTrusted |
この新しいパートナを信頼するかどうかを示す値。値は次のいずれかです。
|
例
次の呼出しは、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")
5.1.8 deletePartner
deletePartnerコマンドはオンライン・コマンドで、セキュリティ・トークン・サービスからパートナ・エントリを削除します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
セキュリティ・トークン・サービス.から、partnerId
パラメータによって参照される既存のパートナ・エントリを削除し、操作の結果を出力します。
構文
deletePartner(partnerId)
引数 | 定義 |
---|---|
partnerId |
削除するパートナのIDを指定します。 |
例
次の呼出しは、セキュリティ・トークン・サービスから、partnerIdパラメータによって参照されるcustomPartner
パートナ・エントリを削除し、操作の結果を出力します。
deletePartner(partnerId="customPartner")
5.1.9 getPartnerUsernameTokenUsername
getPartnerUsernameTokenUsernameコマンドはオンライン・コマンドで、UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのユーザー名値を取得します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのユーザー名値を取得し、値を表示します。
構文
getPartnerUsernameTokenUsername(partnerId)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
例
次の呼出しは、UNT資格証明パートナ検証またはマッピング操作に使用される、customPartner
パートナ・ユーザー名値を取得し、値を表示します。
getPartnerUsernameTokenUsername(partnerId="customPartner")
5.1.10 getPartnerUsernameTokenPassword
getPartnerUsernameTokenPasswordコマンドはオンライン・コマンドで、UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのパスワード値を取得します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・パスワード値を取得し、値を表示します。
構文
getPartnerUsernameTokenPassword(partnerId)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
例
次の呼出しは、UNT資格証明パートナ検証またはマッピング操作に使用される、customPartner
パートナ・パスワード値を取得し、値を表示します。
getPartnerUsernameTokenPassword(partnerId="customPartner")
5.1.11 setPartnerUsernameTokenCredential
setPartnerUsernameTokenCredentialコマンドはオンライン・コマンドで、UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・エントリのユーザー名およびパスワード値を設定します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・エントリのユーザー名およびパスワード値を設定します。操作の結果を表示します。
構文
setPartnerUsernameTokenCredential(partnerId, UTUsername, UTPassword)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
UTUsername |
UNT資格証明検証またはマッピング操作に使用されるユーザー名値を指定します。 |
UTPassword |
UNT資格証明検証またはマッピング操作に使用されるユーザー名値を指定します。 |
例
次の呼出しは、customPartner
パートナ・エントリのユーザー名およびパスワード値を設定し、操作の結果を表示します。
setPartnerUsernameTokenCredential(partnerId="customPartner", UTUsername="test", UTPassword="password")
5.1.12 deletePartnerUsernameTokenCredential
deletePartnerUsernameTokenCredentialコマンドはオンライン・コマンドで、パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。
構文
deletePartnerUsernameTokenCredential(partnerId)
引数 | 定義 |
---|---|
partnerId |
削除するパートナのIDを指定します。 |
例
次の呼出しは、パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。
deletePartnerUsernameTokenCredential(partnerId="customPartner")
5.1.13 getPartnerSigningCert
getPartnerSigningCertコマンドはオンライン・コマンドで、partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。
構文
getPartnerSigningCert(partnerId)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
例
次の呼出しは、partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。
getPartnerSigningCert(partnerId="customPartner")
5.1.14 getPartnerEncryptionCert
getPartnerEncryptionCertコマンドはオンライン・コマンドで、Base64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
partnerIdパラメータによって参照されるパートナのBase64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。
構文
getPartnerEncryptionCert(partnerId)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
例
次の呼出しは、partnerIdパラメータによって参照されるパートナのBase64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。
getPartnerEncryptionCert(partnerId="customPartner")
5.1.15 setPartnerSigningCert
setPartnerSigningCertコマンドはオンライン・コマンドで、提供された証明書を署名証明書としてパートナ・エントリにアップロードします。操作の結果を表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
提供された証明書を署名証明書として(partnerIdパラメータによって参照される)パートナ・エントリにアップロードします。サポートされている証明書の形式は、DERおよびPEMです。操作の結果を表示します。
構文
setPartnerSigningCert(partnerId, certFile)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
certFile |
ローカル・ファイル・システムの証明書の場所を指定します。サポートされている証明書の形式は、DERおよびPEMです。 |
例
次の呼出しは、提供された証明書を署名証明書としてパートナ・エントリcustomPartner
にアップロードします。操作の結果を表示します。
setPartnerSigningCert(partnerId="customPartner", certFile="/temp/signing_cert")
5.1.16 setPartnerEncryptionCert
setPartnerEncryptionCertコマンドはオンライン・コマンドで、提供された証明書を暗号化証明書としてパートナ・エントリにアップロードします。操作の結果を表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
提供された証明書を暗号化証明書として(partnerIdパラメータによって参照される)パートナ・エントリにアップロードします。操作の結果を表示します。
構文
setPartnerEncryptionCert(partnerId, certFile)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
certFile |
ローカル・ファイル・システム上の証明書の場所を指定します。サポートされている証明書の形式は、DERおよびPEMです。 |
例
次の呼出しは、提供された証明書を署名証明書としてパートナ・エントリcustomPartner
にアップロードします。操作の結果を表示します。
setPartnerSigningCert(partnerId="customPartner", certFile="/temp/signing_cert")
5.1.17 deletePartnerSigningCert
deletePartnerSigningCertコマンドはオンライン・コマンドで、パートナ・エントリから暗号化証明書を削除し、操作の結果を表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
partnerIdパラメータによって参照されるパートナ・エントリから暗号化証明書を削除し、操作の結果を表示します。
構文
deletePartnerSigningCert(partnerId)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
例
次の呼出しは、パートナ・エントリcustomPartner
から暗号化証明書を削除し、操作の結果を表示します。
deletePartnerSigningCert(partnerId="customPartner")
5.1.18 deletePartnerEncryptionCert
deletePartnerEncryptionCertコマンドはオンライン・コマンドで、パートナ・エントリから署名証明書を削除し、操作の結果を表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
partnerIdパラメータによって参照されるパートナ・エントリから署名証明書を削除し、操作の結果を表示します。
構文
deletePartnerEncryptionCert(partnerId)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
例
次の呼出しは、パートナ・エントリcustomPartner
から署名証明書を削除し、操作の結果を表示します。
deletePartnerEncryptionCert(partnerId="customPartner")
5.1.19 getPartnerAllIdentityAttributes
getPartnerAllIdentityAttributesコマンドはオンライン・コマンドで、リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。
アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです。
構文
getPartnerAllIdentityAttributes(partnerId)
引数 | 定義 |
---|---|
partnerId |
リクエスタ・パートナのIDを指定します。アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです |
例
次の呼出しは、リクエスタ・パートナcustomPartner
にトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。
getPartnerAllIdentityAttributes(partnerId="customPartner")
5.1.20 getPartnerIdentityAttribute
getPartnerIdentityAttributeコマンドはオンライン・コマンドで、リクエスタ・パートナにトークンまたはバインディング・データをマップするために使用されるアイデンティティ・マッピング属性を取得して表示します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるアイデンティティ・マッピング属性を取得して表示します。
アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです。
構文
getPartnerIdentityAttribute(partnerId, identityAttributeName)
引数 | 定義 |
---|---|
partnerId |
リクエスタ・パートナのIDを指定します。 |
IdentityAttributeName |
取得および表示するアイデンティティ・マッピング属性の名前を指定します。たとえば、 |
例
次の呼出しは、identityAttributeName
によって指定されたidentityAttribute
とその値を取得して表示します。
getPartnerIdentityAttribute(partnerId="customPartner", identityAttributeName="httpbasicusername")
5.1.21 setPartnerIdentityAttribute
setPartnerIdentityAttributeコマンドはオンライン・コマンドで、リクエスタ・パートナのアイデンティティ・マッピング属性を設定します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
partnerIdパラメータによって指定されたリクエスタ・タイプのパートナに対して、identityAttributeName
によって指定されたアイデンティティ・マッピング属性を設定します。それらのアイデンティティ・マッピング属性があるのは、リクエスタ・パートナのみです。操作の結果を表示します。
構文
setPartnerIdentityAttribute(partnerId, identityAttributeName, identityAttributeValue)
引数 | 定義 |
---|---|
partnerId |
リクエスタ・タイプのパートナのIDを指定します。 |
identityAttributeName |
取得および表示するアイデンティティ・マッピング属性の名前を指定します。 |
identityAttributeValue |
設定するアイデンティティ・マッピング属性の値を指定します。 |
例
次の呼出しは、partnerIdパラメータによって指定されたリクエスタ・タイプのリクエスタ・パートナに対して、identityAttributeName
によって指定されたアイデンティティ・マッピング属性を設定します。操作の結果を表示します。
setPartnerIdentityAttribute(partnerId="customPartner", identityAttributeName="httpbasicusername",identityAttributeValue="test")
5.1.22 deletePartnerIdentityAttribute
deletePartnerIdentityAttributeコマンドはオンライン・コマンドで、アイデンティティ・マッピング属性を削除します。このコマンドはパートナ・コマンドのカテゴリに属します。
説明
identityAttributeName
によって指定されたアイデンティティ・マッピング属性を削除します。
リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるアイデンティティ・マッピング属性。それらの属性があるのは、リクエスタ・パートナのみです。
構文
deletePartnerIdentityAttribute(partnerId, identityAttributeName)
引数 | 定義 |
---|---|
partnerId |
パートナのIDを指定します。 |
identityAttributeName |
削除するアイデンティティ・マッピング属性の名前を指定します。 |
例
次の呼出しは、リクエスタ・パートナcustomPartner
に対して、identityAttributeName
によって指定されたアイデンティティ・マッピング属性を削除します。
deletePartnerIdentityAttribute(partnerId="customPartner", identityAttributeName="httpbasicusername")
5.1.23 getAllWSPrefixAndPartnerMappings
getAllWSPrefixAndPartnerMappingsコマンドはオンライン・コマンドで、リライイング・パーティ・パートナ・マッピングに対するすべてのWS接頭辞を取得して表示します。このコマンドは、リライイング・パーティ・パートナ・マッピング・コマンドのカテゴリに属します。
説明
リライイング・パーティ・パートナ・マッピングに対するすべてのWS接頭辞を取得して表示します。
構文
getAllWSPrefixAndPartnerMappings()
例
次の呼出しは、WS接頭辞を取得して表示します。
getAllWSPrefixAndPartnerMappings()
5.1.24 getWSPrefixAndPartnerMapping
getWSPrefixAndPartnerMappingコマンドはオンライン・コマンドで、指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。このコマンドは、リライイング・パーティ・パートナ・マッピング・コマンドのカテゴリに属します。
説明
指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。
構文
getWSPrefixAndPartnerMapping(wsprefix)
引数 | 定義 |
---|---|
wsprefix |
取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。 http_protocol://hostname_ip/path |
例
次の呼出しは、指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。
getWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path")
5.1.25 createWSPrefixAndPartnerMapping
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")
5.1.26 deleteWSPrefixAndPartnerMapping
deleteWSPrefixAndPartnerMappingコマンドはオンライン・コマンドで、リライイング・パートナへのWS接頭辞の既存のマッピングを削除します。このコマンドは、リライイング・パーティ・パートナ・マッピング・コマンドのカテゴリに属します。
説明
リライイング・パートナへのWS接頭辞の既存のマッピングを削除し、操作の結果を表示します。
構文
deleteWSPrefixAndPartnerMapping(wsprefix)
引数 | 定義 |
---|---|
wsprefix |
取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。 http_protocol://hostname_ip/path |
例
次の呼出しは、リライイング・パートナへのWS接頭辞の既存のマッピングを削除し、操作の結果を表示します。
deleteWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path")
5.1.27 getAllPartnerProfiles
getAllPartnerProfilesコマンドはオンライン・コマンドで、既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。このコマンドは、パートナ・プロファイル・コマンドのカテゴリに属します。
説明
既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。
構文
getAllPartnerProfiles()
例
次の呼出しは、既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。
getAllPartnerProfiles()
5.1.28 getPartnerProfile
getPartnerProfileコマンドはオンライン・コマンドで、特定のパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。このコマンドは、パートナ・プロファイル・コマンドのカテゴリに属します。
説明
partnerProfileIdパラメータによって参照されるパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。
構文
getPartnerProfile(partnerProfileId)
引数 | 定義 |
---|---|
partnerProfileId |
パートナ・プロファイルの名前を指定します。 |
例
次の呼出しは、partnerProfileIdパラメータによって参照されるパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。
getPartnerProfile(partnerProfileId="custom-partnerprofile")
5.1.29 createRequesterPartnerProfile
createRequesterPartnerProfileコマンドはオンライン・コマンドで、デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成します。このコマンドは、パートナ・プロファイル・コマンドのカテゴリに属します。
説明
デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成し、操作の結果を表示します。
表5-2では、このコマンドで作成されるデフォルト構成について説明します。
表5-2 デフォルト構成: createRequesterPartnerProfile
要素 | 説明 |
---|---|
Return Error for Missing Claims |
デフォルト: false |
Allow Unmapped Claims |
デフォルト: false |
Token Type Configuration |
「トークン・タイプ構成」表には、次のエントリが含まれます。WS-Trust検証テンプレートへのトークン・タイプのマッピングはありません。
ノート: トークン・タイプ構成、および検証テンプレート・マッピングに対するトークン・タイプはいずれも空になります |
Attribute Name Mapping |
デフォルト: Attribute Name Mapping表は、デフォルトでは空です。 |
構文
createRequesterPartnerProfile(partnerProfileId, defaultRelyingPartyPPID, description)
引数 | 定義 |
---|---|
partnerProfileId |
パートナ・プロファイルの名前を指定します。 |
defaultRelyingPartyPPID |
RSTにAppliesToフィールドがない場合、またはAppliesToフィールドをリライイング・パーティ・パートナにマップできない場合に使用するリライイング・パーティ・パートナ・プロファイルを指定します。 |
description |
このパートナ・プロファイルの説明(オプション)を指定します |
例
次の呼出しは、デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成し、操作の結果を表示します。デフォルト・データの説明については、表5-2を参照してください。
createRequesterPartnerProfile(partnerProfileId="custom-partnerprofile", defaultRelyingPartyPPID="rpPartnerProfileTest", description="custom partner profile")
5.1.30 createRelyingPartyPartnerProfile
createRelyingPartyPartnerProfileコマンドはオンライン・コマンドで、デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成します。このコマンドは、パートナ・プロファイル・コマンドのカテゴリに属します。
説明
デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成し、操作の結果を表示します。
表5-3では、このコマンドで作成されるデフォルト構成について説明します。
表5-3 デフォルト構成: createRelyingPartyPartnerProfile
要素 | 説明 |
---|---|
ポリシーのダウンロード |
デフォルト: false |
マップされていない要求を許可 |
デフォルト: false |
トークン・タイプ構成 |
「トークン・タイプ構成」には、次のような単一のエントリが含まれます。
ノート: 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")
5.1.31 createIssuingAuthorityPartnerProfile
createIssuingAuthorityPartnerProfileコマンドはオンライン・コマンドで、デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成します。このコマンドは、パートナ・プロファイル・コマンドのカテゴリに属します。
説明
表5-4のデフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成し、操作の結果を表示します。
表5-4 デフォルト構成: createIssuingAuthorityPartnerProfile
要素 | 説明 |
---|---|
サーバー・クロック・ドリフト |
デフォルト: 600秒 |
トークン・マッピング |
「トークン・マッピング」セクションは、次のように構成されます。
空のフィールド
|
パートナ名前IDマッピング |
パートナ名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。ただし、データストア列内にデータがない場合、defaultIssuanceTemplateIDによって参照される発行テンプレートは、トークン・タイプがSAML 1.1、SAML 2.0またはユーザー名である発行テンプレートです。 この表には、次のエントリが含まれます。
|
ユーザー名前IDマッピング |
ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。
|
属性マッピング |
「属性値マッピング」および「属性名マッピング」表は、デフォルトでは空です。 |
構文
createIssuingAuthorityPartnerProfile(partnerProfileId, description)
引数 | 定義 |
---|---|
partnerProfileId |
パートナ・プロファイルの名前を指定します。 |
description |
このパートナ・プロファイルの説明(オプション)を指定します |
例
次の呼出しは、デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成し、操作の結果を表示します。
createIssuingAuthorityPartnerProfile(partnerProfileId="custom-partnerprofile" description="custom partner profile")
5.1.32 deletePartnerProfile
deletePartnerProfileコマンドはオンライン・コマンドで、partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除します。このコマンドは、パートナ・プロファイル・コマンドのカテゴリに属します。
説明
partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除し、操作の結果を表示します。SAML 1.1については、「Advanced Identity Federationのコマンド」を参照してください。
構文
deletePartnerProfile(partnerProfileId)
引数 | 定義 |
---|---|
partnerProfileId |
削除するパートナ・プロファイルの名前を指定します。 |
例
次の呼出しは、partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除し、操作の結果を表示します。
deletePartnerProfile(partnerProfileId="custom-partnerprofile")
5.1.33 getAllIssuanceTemplates
getAllIssuanceTemplatesコマンドはオンライン・コマンドで、既存のすべての発行テンプレートの名前を取得します。このコマンドは、発行テンプレート・コマンドのカテゴリに属します。
説明
既存のすべての発行テンプレートの名前を取得し、それらを表示します。
構文
getAllIssuanceTemplates
例
次の呼出しは、既存のすべての発行テンプレートの名前を取得し、それらを表示します。
getAllIssuanceTemplates
5.1.34 getIssuanceTemplate
getIssuanceTemplateコマンドはオンライン・コマンドで、特定の発行テンプレートの構成データを取得します。このコマンドは、発行テンプレート・コマンドのカテゴリに属します。
説明
issuanceTemplateIdパラメータによって参照される発行テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。
構文
getIssuanceTemplate(issuanceTemplateId)
引数 | 定義 |
---|---|
issuanceTemplateId |
発行テンプレートの名前を指定します。 |
例
次の呼出しは、issuanceTemplateIdパラメータによって参照される発行テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。
getIssuanceTemplate(issuanceTemplateId="custom-issuancetemp")
5.1.35 createIssuanceTemplate
createIssuanceTemplateコマンドはオンライン・コマンドで、デフォルトの構成データを使用して新しい発行テンプレートを作成します。このコマンドは、発行テンプレート・コマンドのカテゴリに属します。
説明
デフォルトの構成データを使用して新しい発行テンプレートを作成し、操作の結果を表示します。
表5-5では、このコマンドのデフォルト構成について説明します。
表5-5 デフォルト構成: createIssuanceTemplate
トークンのタイプ | 説明 |
---|---|
ユーザー名 |
発行テンプレートは、次のデフォルト値を使用して作成されます。
|
SAML 1.1 または SAML 2.0 |
発行テンプレートは、次のデフォルト値を使用して作成されます。
空の表: 属性名マッピング、属性値マッピングおよび属性値フィルタ |
カスタム・タイプ |
発行テンプレートは、次のデフォルト値を使用して作成されます。
|
構文
createIssuanceTemplate(issuanceTemplateId, tokenType, signingKeyId, description)
引数 | 定義 |
---|---|
issuanceTemplateId |
作成する発行テンプレートの名前を指定します。 |
tokenType |
指定できる値は次のとおりです:
|
signingKeyId |
送信SAMLアサーションに署名するために使用されるキー・エントリ(STS一般設定のUIセクションで定義されています)を参照するkeyIDを指定します。トークン・タイプがsaml11またはsaml20である場合のみ必須です。 |
description |
説明(オプション)。 |
例
次の呼出しは、デフォルトの構成データを使用して新しい発行テンプレートを作成し、操作の結果を表示します。
createIssuanceTemplate(issuanceTemplateId="custom-issuancetemp", tokenType="saml20", signingKeyId="osts_signing", description="custom issuance template")
5.1.36 deleteIssuanceTemplate
deleteIssuanceTemplateコマンドはオンライン・コマンドで、issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。このコマンドは、発行テンプレート・コマンドのカテゴリに属します。
説明
issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。
構文
deleteIssuanceTemplate(issuanceTemplateId)
引数 | 定義 |
---|---|
issuanceTemplateId |
削除する既存の発行テンプレートの名前を指定します。 |
例
次の呼出しは、issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。
deleteIssuanceTemplate(issuanceTemplateId="custom-issuancetemp")
5.1.37 getAllValidationTemplates
getAllValidationTemplatesコマンドはオンライン・コマンドで、既存のすべての検証テンプレートの名前を取得します。このコマンドは、検証テンプレート・コマンドのカテゴリに属します。
説明
既存のすべての検証テンプレートの名前を取得し、それらを表示します。
構文
getAllValidationTemplates()
例
次の呼出しは、既存のすべての検証テンプレートの名前を取得し、それらを表示します。
getAllValidationTemplates()
5.1.38 getValidationTemplate
getValidationTemplateコマンドはオンライン・コマンドで、特定の検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。このコマンドは、検証テンプレート・コマンドのカテゴリに属します。
説明
validationTemplateIdパラメータによって参照される検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。
構文
getValidationTemplate(validationTemplateId)
引数 | 定義 |
---|---|
validationTemplateId |
既存の検証テンプレートの名前を指定します。 |
例
次の呼出しは、特定の検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。
getValidationTemplate(validationTemplateId="custom-wss-validtemp")
5.1.39 createWSSValidationTemplate
createWSSValidationTemplateコマンドはオンライン・コマンドで、デフォルトの構成データを使用して新しい検証テンプレートを作成します。このコマンドは、検証テンプレート・コマンドのカテゴリに属します。
説明
デフォルトの構成データを使用して新しいWSS検証テンプレートを作成し、操作の結果を表示します。検証テンプレートは、トークン・タイプに応じて表5-6の値を使用して作成されます。
表5-6 デフォルト構成: createWSSValidationTemplate
トークンのタイプ | 説明 |
---|---|
ユーザー名 |
検証テンプレートは、次のデフォルト値を使用して作成されます。
|
SAML 1.1 または SAML 2.0 |
検証テンプレートは、次のデフォルト値を使用して作成されます。
「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。
空のフィールド: ユーザー・トークン属性、ユーザー・データストア属性および属性ベース・ユーザー・マッピング 追記:
パートナ名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされますが、データストア列内のデータは使用されません。
ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。
|
X.509 |
「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。
空のフィールド: ユーザー・トークン属性、ユーザー・データストア属性および属性ベース・ユーザー・マッピング 追記:
|
Kerberos |
「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。
空のフィールド: パートナ・トークン属性、パートナ・データストア属性および属性ベース・ユーザー・マッピング 追記:
|
構文
createWSSValidationTemplate(templateId, tokenType, defaultRequesterPPID, description)
引数 | 定義 |
---|---|
templateId |
作成する検証テンプレートの名前を指定します。 |
tokenType |
検証テンプレートのトークン・タイプを指定します。指定できる値は次のとおりです:
|
defaultRequesterPPID |
OSTSが着信メッセージをリクエスタにマップしないように構成されている場合に使用するリクエスタ・パートナ・プロファイルを指定します。 |
description |
説明を指定します(オプション)。 |
例
次の呼出しは、デフォルトの構成データを使用して新しい検証テンプレートを作成し、操作の結果を表示します。
createWSSValidationTemplate(templateId="custom-wss-validtemp", tokenType="custom", defaultRequesterPPID="requesterPartnerProfileTest", description="custom validation template")
5.1.40 createWSTrustValidationTemplate
createWSTrustValidationTemplateコマンドはオンライン・コマンドで、デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成します。このコマンドは、検証テンプレート・コマンドのカテゴリに属します。
説明
デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成し、操作の結果を表示します。WS-Trust検証テンプレートは、トークン・タイプに応じて表5-7の値を使用して作成されます。
表5-7 デフォルト構成: createWSTrustValidationTemplate
トークンのタイプ | 説明 |
---|---|
ユーザー名 |
WS-Trust検証テンプレートは、次のデフォルト値を使用して作成されます。
|
SAML 1.1 または SAML 2.0 |
WS-Trust検証テンプレートは、次のデフォルト値を使用して作成されます。
「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。
空のフィールド: ユーザー・データストア属性、属性ベース・ユーザー・マッピング ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。
|
X.509 |
WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。
|
Kerberos |
WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。
|
OAM |
WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。
|
カスタム |
WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。
|
構文
createWSTrustValidationTemplate(templateId, tokenType, description)
引数 | 定義 |
---|---|
templateId |
作成するWS-Trust検証テンプレートの名前を指定します。 |
tokenType |
WS-Trust検証テンプレートのトークン・タイプを指定します。指定できる値は次のとおりです:
|
description |
説明を指定します(オプション)。 |
例
次の呼出しは、デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成し、操作の結果を表示します。
createWSTrustValidationTemplate(templateId="custom-wss-validtemp", tokenType="custom", description="custom validation template")
5.1.41 deleteValidationTemplate
deleteValidationTemplateコマンドはオンライン・コマンドで、検証テンプレートを削除します。このコマンドは、検証テンプレート・コマンドのカテゴリに属します。
説明
validationTemplateIdパラメータによって参照される検証テンプレートを削除し、操作の結果を表示します。
構文
deleteValidationTemplate(validationTemplateId)
引数 | 定義 |
---|---|
validationTemplateId |
削除する検証テンプレートの名前を指定します。 |
例
次の呼出しは、validationTemplateIdパラメータによって参照される検証テンプレートを削除し、操作の結果を表示します。
deleteValidationTemplate(validationTemplateId="custom-wss-validtemp")
5.1.42 configureOWSMAgentSTS
configureOWSMAgentSTSコマンドは、モバイル・セキュリティ・アクセス・サーバー(MSAS)/Oracle Web Services Manager (OWSM)のカスタム・ポリシーの機能を許可するために必要なオンライン・コマンドです。このコマンドは、検証テンプレート・コマンドのカテゴリに属します。
説明
オンライン・コマンドでは、MSAS/OWSMのカスタム・ポリシーの機能を許可するようにセキュリティ・トークン・サービスの構成を変更します。
構文
configureOWSMAgentSTS(<type>, <server="soa_server1">)
引数 | 定義 |
---|---|
type |
タイプは'classpath'または'policymanager'です。OWSMポリシー・マネージャ・サービスがSTSポリシーにシードされる必要がある場合は、'policymanager'を渡します。それ以外は、'password'を使用し、STSポリシーがsts_policies.jarから選択されます。 |
|
オプション。type=policymanagerの場合、OWSMドキュメント・マネージャMBeanがデプロイされているWLS管理対象サーバー名を入力します。 |
例
configureOWSMAgentSTS("policymanager", server="omsm_server1")