ジャンプ先

• リクエスト
• レスポンス

パートナの作成

post

/oam/services/rest/11.1.2.0.0/fed/admin/trustedsppartners

このRESTエンドポイント・サービス・リクエストは、FORMデータを使用して信頼できるSPパートナを作成するのに使用します。

リクエスト

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

• multipart/form-data

フォーム・パラメータ

• assertionConsumerURL: string
  ユーザーがSAML 2.0アサーションでIdPによりリダイレクトされるSAML 2.0アサーション・コンシューマ・サービスURL
• customAttrs: string
  オプション属性のリストを示します(指定されない場合、属性は送信されません)
• emailAttrName: string
  ユーザーのEメールを含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名にはEメールは設定されません)
• encryptionCert: string
  暗号化されたSAMLメッセージを復号化するためにSPによって使用される、Base64でエンコードされたX.509暗号化証明書
• firstNameAttrName: string
  ユーザーの名を含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名には姓は設定されません)
• generateNewKeys: string
  新しいキーとそれに対応する自己署名証明書をSAML操作用に生成する必要があるかどうか、そして新しい暗号化実体を再生成する必要があるかどうかを示します。

  使用可能な値: [ "true", "false" ]
• idpTenantName: string
  PaaSでの顧客のテナント名(OIFでマルチ・テナントが有効化されている場合にのみ使用されます)
• idpTenantURL: string
  顧客のテナントURLパス。(OIFでマルチ・テナントが有効化されている場合にのみ使用され、必須です)
• lastNameAttrName: string
  ユーザーの姓を含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名には名は設定されません)
• logoutRequestURL: string
  SAMLによるログアウト・リダイレクト・プロファイルの、ユーザーをSPにリダイレクトするためにIdPにより使用されるURL
• logoutResponseURL: string
  SAML LogoutResponseによるログアウト・リダイレクト・プロファイルの、ユーザーをSPにリダイレクトするためにIdPにより使用されるURL
• metadata: string
  IdPに送信される、SPサーバーのBase64エンコード済メタデータ。指定されない場合、metadataURLが使用されます
• metadataURL: string
  SPメタデータがダウンロード可能なURL
• nameIDFormat: string
  フェデレーションSSO時に使用されるNameID形式。emailaddressの場合は、IdPが作成するアサーションのNameID値にユーザーのEメールアドレスが格納され、unspecifiedの場合は、IdPが作成するアサーションのNameID値にユーザーのIDが格納されます
• preverify: string
  コールで事前検証チェックを実行するかどうかを示すboolean。trueの場合、後続の呼び出しで変更が実行される前にサービスにおいてメソッドが呼び出せるようになっている必要があります

  デフォルト値: false
• signingCert: string
  メッセージを署名するためにSPによって使用される、Base64でエンコードされたX.509署名証明書
• spPartnerName: string
  使用するパートナ名
• spProviderID: string
  SPのProviderID
• ssoProfile: string
  使用するSAML 2.0 SSOプロファイル

  使用可能な値: [ "artifact", "httppost" ]
• staticAttrName: string
  静的属性を送信する必要があるかおよびどのように参照するかを示します(指定されない場合、属性は送信されません)。staticAttrNameおよびstaticAttrValueは必須です
• staticAttrValue: string
  静的属性を送信する必要があるかおよびどの値を使用するかを示します(指定されない場合、属性は送信されません)。staticAttrNameおよびstaticAttrValueは必須です
• userNameAttrName: string
  ユーザーIDを含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名にはユーザー名は設定されません)
• validityNewKeys: string
  自己署名証明書の有効日数を示します

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: statusResponse

タイプ: object

ステータス・レスポンス

ソースを表示

• status: integer(int32)
  ステータス・コード: 成功の場合1、失敗の場合0
• statusMessage: string
  ステータス・メッセージ

{
    "description":"Status Response",
    "properties":{
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"Status Code: 1 for success and 0 for failure"
        },
        "statusMessage":{
            "type":"string",
            "description":"Status Message"
        }
    }
}

400レスポンス

不正なリクエスト。

500レスポンス

内部サーバー・エラー。

先頭に戻る