ジャンプ先

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

パートナの更新

put

/oam/services/rest/11.1.2.0.0/fed/admin/trustedpartners/sp/{partnerName}

特定のSPパートナ・リソースをこのメソッドで更新します。ここで、partnerNameは更新するパートナの名前です。

リクエスト

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

• application/json
• application/xml
• text/xml

パス・パラメータ

• partnerName(required): string
  SPパートナ名

本文()

SPパートナ詳細

ルート・スキーマ: spPartnerData

タイプ: object

SPパートナのデータセット

ソースを表示

• adminFedInstanceType: string
  使用可能な値: [ "facloud", "onpremise" ]

  フェデレーション・パートナのタイプを示します

  • facloud: FA SaaSクラウドOIFサーバーを表します
  • onpremise: 顧客が所有するフェデレーション・サーバーを表します
• assertionConsumerURL: string
  ユーザーがSAML 2.0アサーションでIdPによりリダイレクトされるSAML 2.0アサーション・コンシューマ・サービスURL
• customAttrsStr: string
  オプション属性のリストを示します(指定されない場合、属性は送信されません)
• emailAttrName: string
  ユーザーのEメールを含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名にはEメールは設定されません)
• encryptionCert: string
  暗号化されたSAMLメッセージを復号化するためにSPによって使用される、Base64でエンコードされたX.509暗号化証明書
• encryptionKeystoreAccessTemplateId: string
  暗号化証明書で使用されるキーストア・アクセス・テンプレートIDを示します。このパラメータが設定されていない場合のデフォルト値はosts_encryptionです
• firstNameAttrName: string
  ユーザーの名を含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名には姓は設定されません)
• generateNewKeys: string
  使用可能な値: [ "true", "false" ]

  新しいキーとそれに対応する自己署名証明書をSAML操作用に生成する必要があるかどうか、そして新しい暗号化実体を再生成する必要があるかどうかを示します。
• lastNameAttrName: string
  ユーザーの姓を含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名には名は設定されません)
• logoutRequestURL: string
  SAMLによるログアウト・リダイレクト・プロファイルの、ユーザーをSPにリダイレクトするためにIdPにより使用されるURL
• logoutResponseURL: string
  SAML LogoutResponseによるログアウト・リダイレクト・プロファイルの、ユーザーをSPにリダイレクトするためにIdPにより使用されるURL
• metadataB64: string
  IdPに送信される、SPサーバーのBase64エンコード済メタデータ。指定されない場合、metadataURLが使用されます
• metadataURL: string
  SPメタデータがダウンロード可能なURL
• nameIDFormat: string
  使用可能な値: [ "emailaddress", "unspecified" ]

  フェデレーションSSO時に使用されるNameID形式。emailaddressの場合は、IdPが作成するアサーションのNameID値にユーザーのEメールアドレスが格納され、unspecifiedの場合は、IdPが作成するアサーションのNameID値にユーザーのIDが格納されます
• partnerName: string
  使用するパートナ名
• partnerType: string
  使用可能な値: [ "sp" ]

  パートナ・タイプ
• preverify: string
  コールで事前検証チェックを実行するかどうかを示すboolean。trueの場合、後続の呼び出しで変更が実行される前にサービスにおいてメソッドが呼び出せるようになっている必要があります
• providerID: string
  SPのProviderID
• signatureDigestAlgorithm: string
  SAML署名ハッシュ・アルゴリズムが使用されることを示します。使用可能な値は、SHA-1またはSHA-256です。このパラメータが設定されていない場合のデフォルト値はSHA-1です
• signingCert: string
  メッセージを署名するためにSPによって使用される、Base64でエンコードされたX.509署名証明書
• signingKeystoreAccessTemplateId: string
  署名証明書で使用されるキーストア・アクセス・テンプレートIDを示します。このパラメータが設定されていない場合のデフォルト値はosts_signingです
• ssoProfile: string
  使用可能な値: [ "httppost", "artifact" ]

  使用するSAML 2.0 SSOプロファイル
• ssoSOAPURL: string
  SPパートナのSSO SOAP URL
• ssoURL: string
  ユーザーがリダイレクト・プロファイルによるSAML 2.0 AuthnRequestでSPによりリダイレクトされるSAML 2.0シングル・サインオン・サービスURL
• staticAttrName: string
  静的属性を送信する必要があるかおよびどのように参照するかを示します(指定されない場合、属性は送信されません)。staticAttrNameおよびstaticAttrValueは必須です
• staticAttrValue: string
  静的属性を送信する必要があるかおよびどの値を使用するかを示します(指定されない場合、属性は送信されません)。staticAttrNameおよびstaticAttrValueは必須です
• tenantName: string
  PaaSでの顧客のテナント名(OIFでマルチ・テナントが有効化されている場合にのみ使用されます)
• tenantURL: string
  : 顧客のテナントURLパス。(OIFでマルチ・テナントが有効化されている場合にのみ使用され、必須です)
• userNameAttrName: string
  ユーザーIDを含めた場合に、SAML 2.0アサーションで使用するSAML属性名を示します(指定されない場合、属性名にはユーザー名は設定されません)
• validityNewKeys: string
  自己署名証明書の有効日数を示します

{
    "description":"Data-Set of SP Partner",
    "type":"object",
    "properties":{
        "metadataB64":{
            "type":"string",
            "description":"the Base64 encoded metadata of the SP server that will be sent to the IdP. If not specified, metadataURL will be used"
        },
        "metadataURL":{
            "type":"string",
            "description":"URL where the SP metadata can be downloaded"
        },
        "partnerType":{
            "type":"string",
            "description":"Partner Type",
            "enum":[
                "sp"
            ]
        },
        "tenantName":{
            "type":"string",
            "description":"the customers' tenant name in the PaaS (only used if OIF is multi tenant enabled)"
        },
        "tenantURL":{
            "type":"string",
            "description":": the customers' tenant URL path.  (only used if OIF is multi tenant enabled; required)"
        },
        "partnerName":{
            "type":"string",
            "description":"the partner name to be used"
        },
        "nameIDFormat":{
            "type":"string",
            "description":"the NameID format used during Federation SSO. If emailaddress, then the NameID value of an Assertion created by the IdP will contain the user's email address; if unspecified, then the NameID value of an Assertion created by the IdP will contain the user's ID",
            "enum":[
                "emailaddress",
                "unspecified"
            ]
        },
        "ssoProfile":{
            "type":"string",
            "description":"the SAML 2.0 SSO profile to use",
            "enum":[
                "httppost",
                "artifact"
            ]
        },
        "generateNewKeys":{
            "type":"string",
            "description":"indicates whether or not new keys and corresponding self signed certificates should be generated for SAML operations, also indicates if new cryptographic materials should be re-generated",
            "enum":[
                "true",
                "false"
            ]
        },
        "validityNewKeys":{
            "type":"string",
            "description":"indicates the validity in days of the self signed certificates"
        },
        "preverify":{
            "type":"string",
            "description":"boolean indicating if the call is to perform a pre-verification check. If true, the service will need to ensure the method can be invoked before the changes are performed in a subsequent call"
        },
        "providerID":{
            "type":"string",
            "description":"the SP's ProviderID"
        },
        "ssoURL":{
            "type":"string",
            "description":"the SAML 2.0 Single Sign-On service URL where the user will be redirected by the SP with a SAML 2.0 AuthnRequest with Redirect profile"
        },
        "ssoSOAPURL":{
            "type":"string",
            "description":"SSO SOAP URL for the SP Partner"
        },
        "logoutRequestURL":{
            "type":"string",
            "description":"the URL that will be used by the IdP to redirect the user to the SP for the Logout Redirect profile with the SAML"
        },
        "logoutResponseURL":{
            "type":"string",
            "description":"the URL that will be used by the IdP to redirect the user to the SP for the Logout Redirect profile with the SAML LogoutResponse"
        },
        "assertionConsumerURL":{
            "type":"string",
            "description":"the SAML 2.0 Assertion Consumer service URL where the user will be redirected by the IdP with a SAML 2.0 Assertion"
        },
        "signingCert":{
            "type":"string",
            "description":"the Base64 encoded X.509 Signing Certificate used by the SP to sign messages"
        },
        "encryptionCert":{
            "type":"string",
            "description":"the Base64 encoded X.509 Encryption Certificate used by the SP to decrypt encrypted SAML messages"
        },
        "lastNameAttrName":{
            "type":"string",
            "description":"indicates the SAML Attribute name to use in the SAML 2.0 Assertion when including the user's last name (if missing, then the attribute name will not be set to firstname)"
        },
        "firstNameAttrName":{
            "type":"string",
            "description":"indicates the SAML Attribute name to use in the SAML 2.0 Assertion when including the user's first name (if missing, then the attribute name will not be set to lastname)"
        },
        "userNameAttrName":{
            "type":"string",
            "description":"indicates the SAML Attribute name to use in the SAML 2.0 Assertion when including the userID (if missing, then the attribute name will not be set to username)"
        },
        "emailAttrName":{
            "type":"string",
            "description":"indicates the SAML Attribute name to use in the SAML 2.0 Assertion when including the user's email (if missing, then the attribute name will not be set to email)"
        },
        "staticAttrName":{
            "type":"string",
            "description":"indicates if a static attribute should be sent and how it should be referenced (if missing, then the attribute will not be sent). staticAttrName and staticAttrValue are required"
        },
        "staticAttrValue":{
            "type":"string",
            "description":"indicates if a static attribute should be sent and what value should be used (if missing, then the attribute will not be sent). staticAttrName and staticAttrValue are required"
        },
        "customAttrsStr":{
            "type":"string",
            "description":"indicates a list of optional attributes (if missing, then the attribute will not be sent)"
        },
        "signatureDigestAlgorithm":{
            "type":"string",
            "description":"indicates SAML signature hashing algorithm to be used. Possible values are SHA-1 or SHA-256.  The default value is SHA-1 if this parameter has not been set"
        },
        "signingKeystoreAccessTemplateId":{
            "type":"string",
            "description":"indicates the Keystore access template id to be used in signing certificate. The default value is osts_signing if this parameter has not been set"
        },
        "encryptionKeystoreAccessTemplateId":{
            "type":"string",
            "description":"indicates the Keystore access template id to be used in encryption certificate. The default value is osts_encryption if this parameter has not been set"
        },
        "adminFedInstanceType":{
            "type":"string",
            "description":"indicates the type of Federation partner<ul><li>facloud: represents an FA SaaS Cloud OIF server</li><li>onpremise: represents a customer owned Federation server</li></ul>",
            "enum":[
                "facloud",
                "onpremise"
            ]
        }
    }
}

先頭に戻る

レスポンス

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

• 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レスポンス

内部サーバー・エラー。

先頭に戻る