オーケストレータ・サービス

post

/oam/services/rest/11.1.2.0.0/fed/admin/orchestrator

オーケストレータは、2つのFederationサーバーを一緒に構成するのに使用できるサービスです。
  • オーケストレータは入力として、createIDP | createSP | configureSSO | testSP RESTサービスの場所およびこれらにアクセスする資格証明をとります。
  • この操作に関連するFederationサーバーのタイプは次のとおりです。サーバーのタイプがOIFまたはRESTが有効化されているFederationサーバーの場合、オーケストレータはcreateIDP | createSP | configureSSO | testSP RESTサービスへのアクセスを試行し、そうでない場合はリモート・サーバーでRESTサービスが提供されていないものと見なされます

リクエスト

サポートされているメディア・タイプ
本文()
IDPおよびSPパートナ情報
ルート・スキーマ: OrchestratorInput
タイプ: object
IDPおよびSPパートナのデータセット
ソースを表示
ネストされたスキーマ: idpPartnerInfo
タイプ: object
IDPパートナ情報。
ソースを表示
  • 使用可能な値: [ "facloud", "onpremise" ]
    フェデレーション・パートナのタイプを示します

    ノート: 'facloud'はFA SaaS Cloud OIFサーバーを表し、'onpremise'は顧客が所有するフェデレーション・サーバーを表します

  • ユーザーがSAML 2.0アサーションでIdPによりリダイレクトされるSP SAML 2.0アサーション・コンシューマ・サービスURL
  • アサーションのマッピングがSAML属性により実行されるかどうかを示します。このパラメータは使用するLDAP属性を示します。attributeLDAPおよびattributeSAMLはいずれもSAML属性マッピングが機能するために必要です。指定された場合、アサーション・マッピングにおいてnameIDFormatは無視されます
  • アサーションのマッピングがSAML属性により実行されるかどうかを示します。このパラメータは使用するSAML属性を示します。attributeLDAPおよびattributeSAMLはいずれもSAML属性マッピングが機能するために必要です。指定された場合、アサーション・マッピングにおいてnameIDFormatは無視されます
  • オプション属性のリストをIdPが送信する必要があることを示します(指定されない場合、属性は送信されません)
  • ユーザーのEメールを含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名にはEメールが設定されます)
  • 暗号化されたSAMLメッセージを復号化するためにIdPによって使用される、IdPのBase64でエンコードされたX.509暗号化証明書。これはリモートSPパートナRESTサービスに送信されます
  • 設定するデフォルトのリレー状態で、SPにより使用されます(オプション)
  • ユーザーの名を含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名には姓が設定されます)
  • 使用可能な値: [ "true", "false" ]
    新しいキーとそれに対応する自己署名証明書をIdPがSAML操作用に生成する必要があるかどうかを示します。これはリモートSPパートナRESTサービスに送信されます(オプション)。また、新しい暗号化マテリアルを再生成する必要があるかも示します(trueまたはfalse)
  • ユーザーの姓を含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名には名が設定されます)
  • SAMLによるログアウト・リダイレクト・プロファイルの、ユーザーをIdPにリダイレクトするためにSPにより使用されるIdP URL。これはリモートSPパートナRESTサービスに送信されます
  • SAML LogoutResponseによるログアウト・リダイレクト・プロファイルの、ユーザーをIdPにリダイレクトするためにSPにより使用されるIdP URL。これはリモートSPパートナRESTサービスに送信されます
  • SPに送信される、IdPサーバーのBase64エンコード済メタデータ。指定されない場合、metadataURLが使用されます
  • IdPメタデータがダウンロード可能なURL
  • 使用可能な値: [ "emailaddress", "unspecified" ]
    フェデレーションSSO時に使用されるNameID形式
  • WLS管理サーバーがインストールされているホスト名
  • OAM管理コマンドを発行するのに使用されるWLS管理ユーザー名のパスワード
  • WLS管理サーバーがインストールされているポート
  • OAM管理コマンドを発行するのに使用されるWLS管理ユーザー名
  • IDPパートナのOAMログアウト
  • 使用するパートナ名
  • 使用可能な値: [ "emailaddres", "unspecified" ]

    構成するIDPのタイプ:

    • idptypeがonpremiseの場合、オーケストレータはリモートIdPサーバーのRESTサービスへの接続を試行しません
    • idptypeがそれ以外の場合、オーケストレータはリモートSPサーバーのRESTサービスへの接続を試行します

    ノート: emailaddressの場合は、IdPが作成するアサーションのNameID値にユーザーのEメールアドレスが格納され、unspecifiedの場合は、IdPが作成するアサーションのNameID値にユーザーIDが格納されます。これはリモートSPパートナRESTサービスに送信されます

  • コールで事前検証チェックを実行するかどうかを示すboolean。trueの場合、後続の呼び出しで変更が実行される前にサービスにおいてメソッドが呼び出せるようになっている必要があります。これはリモートSPパートナRESTサービスに送信されます
  • IdPのProviderID。これはリモートSPパートナRESTサービスに送信されます。succinctID: IdPのProviderIDのSHA-1ハッシュ
  • メッセージまたはアサーションの署名のためにIdPによって使用される、IdPのBase64でエンコードされたX.509署名証明書。これはリモートSPパートナRESTサービスに送信されます
  • 使用可能な値: [ "true", "false" ]
    SSOを有効にする必要があるかどうかを示します
  • 使用可能な値: [ "true", "false" ]
    SSOを有効にする必要があるかどうかを示します
  • IDPパートナのモバイルSSO
  • 使用可能な値: [ "artifact", "httppost" ]
    使用するSAML 2.0 SSOプロファイル
  • SPがSSOアーティファクト・プロファイルにおいてSOAPリクエストを送信するIdPのSAML 2.0シングル・サインオン・サービスのSOAP URL。これはリモートSPパートナRESTサービスに送信されます
  • ユーザーがリダイレクト・プロファイルによるSAML 2.0 AuthnRequestでSPによりリダイレクトされるIdPのSAML 2.0シングル・サインオン・サービスURL。これはリモートSPパートナRESTサービスに送信されます
  • 静的属性を送信する必要があるかおよびどのように参照するかを示します(指定されない場合、属性は送信されません)。staticAttrNameおよびstaticAttrValueは必須です
  • 静的属性を送信する必要があるかおよびどの値を使用するかを示します(指定されない場合、属性は送信されません)。staticAttrNameおよびstaticAttrValueは必須です
  • IdPのProviderIDのSHA-1ハッシュ
  • IDPパートナのテナント・キー名
  • IDPパートナのテナント・キー値
  • SPマルチ・テナント・システムにおけるこのIdPのテナント名(SPがMT対応の場合)
  • SPマルチ・テナント・システムにおけるこのIdPのテナントURLパス(SPがMT対応の場合)
  • ユーザーIDを含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名にはユーザー名が設定されます)
  • 自己署名証明書の有効日数を示します
ネストされたスキーマ: spPartnerInfo
タイプ: object
SPパートナ情報。
ソースを表示
  • 使用可能な値: [ "facloud", "onpremise" ]
    フェデレーション・パートナのタイプを示します

    ノート: 'facloud'はFA SaaS Cloud OIFサーバーを表し、'onpremise'は顧客が所有するフェデレーション・サーバーを表します

  • SPパートナのアサーション・コンシューマURL
  • アサーションのマッピングがSAML属性により実行されるかどうかを示します。このパラメータは使用するLDAP属性を示します。attributeLDAPおよびattributeSAMLはいずれもSAML属性マッピングが機能するために必要です。指定された場合、アサーション・マッピングにおいてnameIDFormatは無視されます
  • アサーションのマッピングがSAML属性により実行されるかどうかを示します。このパラメータは使用するSAML属性を示します。attributeLDAPおよびattributeSAMLはいずれもSAML属性マッピングが機能するために必要です。指定された場合、アサーション・マッピングにおいてnameIDFormatは無視されます
  • オプション属性のリストを送信する必要があることを示します(指定されない場合、属性は送信されません)
  • ユーザーのEメールを含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名にはEメールが設定されます)
  • 暗号化されたSAMLメッセージを復号化するためにSPによって使用される、Base64でエンコードされたX.509 SP暗号化証明書
  • 設定するデフォルトのリレー状態で、SPにより使用されます(オプション)
  • ユーザーの名を含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名には姓が設定されます)
  • 使用可能な値: [ "true", "false" ]
    新しいキーとそれに対応する自己署名証明書をIdPがSAML操作用に生成する必要があるかどうかを示します。これはリモートSPパートナRESTサービスに送信されます(オプション)。また、新しい暗号化マテリアルを再生成する必要があるかも示します(trueまたはfalse)
  • ユーザーの姓を含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名には名が設定されます)
  • SAMLによるログアウト・リダイレクト・プロファイルの、ユーザーをSPにリダイレクトするためにIdPにより使用されるSP URL
  • SAML LogoutResponseによるログアウト・リダイレクト・プロファイルの、ユーザーをSPにリダイレクトするためにIdPにより使用されるSP URL
  • IdPに送信される、SPサーバーのBase64エンコード済メタデータ。指定されない場合、spmetadataurlが使用されます
  • SPメタデータがダウンロード可能なURL
  • 使用可能な値: [ "emailaddress", "unspecified" ]
    フェデレーションSSO時に使用されるNameID形式
  • WLS管理サーバーがインストールされているホスト名
  • SPサーバーのWLS管理者のパスワード
  • WLS管理サーバーがインストールされているポート
  • SPサーバーのWLS管理者
  • SPパートナのOAMログアウトURL
  • 使用するパートナ名
  • 構成するSPのタイプ
    • sptypeがsp_manual、taleo_manual、eloqua_manualまたはrightnow_manualの場合、オーケストレータはリモートSPサーバーのRESTサービスへの接続を試行しません
    • sptypeがそれ以外の場合、オーケストレータはリモートSPサーバーのRESTサービスへの接続を試行します
  • コールで事前検証チェックを実行するかどうかを示すboolean。trueの場合、後続の呼び出しで変更が実行される前にサービスにおいてメソッドが呼び出せるようになっている必要があります。これはリモートSPパートナRESTサービスに送信されます
  • SPパートナのプロバイダID
  • メッセージを署名するためにSPによって使用される、Base64でエンコードされたX.509 SP署名証明書
  • 使用可能な値: [ "true", "false" ]
    SSOを有効にする必要があるかどうかを示します
  • 使用可能な値: [ "true", "false" ]
    SSOを有効にする必要があるかどうかを示します
  • SPパートナのモバイルSSO
  • 使用可能な値: [ "artifact", "httppost" ]
    使用するSAML 2.0 SSOプロファイル(artifactまたはhttppost)
  • SPがSSOアーティファクト・プロファイルにおいてSOAPリクエストを送信するIdPのSAML 2.0シングル・サインオン・サービスのSOAP URL。これはリモートSPパートナRESTサービスに送信されます
  • ユーザーがリダイレクト・プロファイルによるSAML 2.0 AuthnRequestでSPによりリダイレクトされるIdPのSAML 2.0シングル・サインオン・サービスURL。これはリモートSPパートナRESTサービスに送信されます
  • 静的属性を送信する必要があるかおよびどのように参照するかを示します(指定されない場合、属性は送信されません)。staticAttrNameおよびstaticAttrValueは必須です
  • 静的属性を送信する必要があるかおよびどの値を使用するかを示します(指定されない場合、属性は送信されません)。staticAttrNameおよびstaticAttrValueは必須です
  • SPパートナの簡潔なID
  • SPマルチ・テナント・システムにおけるこのIdPのテナント名(SPがMT対応の場合)
  • SPマルチ・テナント・システムにおけるこのIdPのテナントURLパス(SPがMT対応の場合)
  • 使用可能な値: [ "true", "false" ]
    trueまたはfalseでテストSPアプリケーションを有効化/無効化するかどうかを示します
  • ユーザーIDを含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名にはユーザー名が設定されます)
  • 自己署名証明書の有効日数を示します
先頭に戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

OK

400レスポンス

不正なリクエスト。Identity Federationが有効になっていないサービス・インスタンスをオーケストレートしようとするときに返されます。

500レスポンス

内部サーバー・エラー。
先頭に戻る