Oracle Access Managerでのフェデレーション・マネージメントREST API

パートナの作成

post

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

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

リクエスト

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

application/json
application/xml
text/xml

パス・パラメータ

partnerName(required): string

IDPパートナ名

IDPパートナ詳細

ルート・スキーマ: idpPartnerData

タイプ: object

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

ソースを表示

adminFedInstanceType: string

IDPパートナのadminFedInstanceType
assertionConsumerURL: string

SAMLアーティファクトによるSSOアーティファクト・プロファイルの、ユーザーをSPにリダイレクトするためにIdPにより使用されるURL
attributeLDAP: string

アサーションのマッピングがSAML属性により実行されるかどうかを示します。このパラメータは使用するLDAP属性を示します。attributeLDAPおよびattributeSAMLはいずれもSAML属性マッピングが機能するために必要です。指定された場合、アサーション・マッピングにおいてnameIDFormatは無視されます
attributeSAML: string

アサーションのマッピングがSAML属性により実行されるかどうかを示します。このパラメータは使用するSAML属性を示します。attributeLDAPおよびattributeSAMLはいずれもSAML属性マッピングが機能するために必要です。指定された場合、アサーション・マッピングにおいてnameIDFormatは無視されます
encryptionCert: string

暗号化されたSAMLメッセージを復号化するためにIdPによって使用される、Base64でエンコードされたX.509暗号化証明書
encryptionKeystoreAccessTemplateId: string

暗号化証明書で使用されるキーストア・アクセス・テンプレートIDを示します。このパラメータが設定されていない場合のデフォルト値はosts_encryptionです
faWelcomePage: string

IdPパートナ・エントリで設定するデフォルトのリレー状態
generateNewKeys: string

使用可能な値: [ "true", "false" ]

新しいキーとそれに対応する自己署名証明書をSAML操作用に生成する必要があるかどうか、新しい暗号化マテリアルを再生成する必要があるかどうかを示します。
logoutRequestURL: string

SAMLによるログアウト・リダイレクト・プロファイルの、ユーザーをIdPにリダイレクトするためにSPにより使用されるURL。
logoutResponseURL: string

SAML LogoutResponseによるログアウト・リダイレクト・プロファイルの、ユーザーをIdPにリダイレクトするためにSPにより使用されるURL
metadataB64: string

SPに送信される、IdPサーバーのBase64エンコード済メタデータ。指定されない場合、idpmetadataurlが使用されます指定がない場合、assertionConsumerServiceArtifactURL、assertionConsumerServicePOSTURL、logoutRequestURL、logoutResponseURL、signingCertおよびencryptionCertフィールドが設定されている必要があり、そうでない場合はこれらのフィールドは無視されます。
metadataURL: string

IdPメタデータがダウンロード可能なURL
nameIDFormat: string

使用可能な値: [ "emailaddress", "unspecified" ]

フェデレーションSSOにおいて使用されるNameID形式で、emailaddressまたはunspecifiedですemailaddressの場合は、IdPが作成するアサーションのNameID値にユーザーのEメールアドレスが格納され、unspecifiedの場合は、IdPが作成するアサーションのNameID値にユーザーのIDが格納されます
partnerName: string

使用するパートナ名
partnerType: string

使用可能な値: [ "idp" ]

パートナ・タイプ
preverify: boolean

'true'に設定された場合、idpパートナのデータセットをテストしますが、実際のパートナは作成されません
providerID: string

IdPのProviderID
signatureDigestAlgorithm: string

SAML署名ハッシュ・アルゴリズムが使用されることを示します。使用可能な値は、SHA-1またはSHA-256です。このパラメータが設定されていない場合のデフォルト値はSHA-1です
signingCert: string

メッセージまたはアサーションの署名のためにIdPによって使用される、Base64でエンコードされたX.509署名証明書
signingKeystoreAccessTemplateId: string

署名証明書で使用されるキーストア・アクセス・テンプレートIDを示します。このパラメータが設定されていない場合のデフォルト値はosts_signingです
ssoProfile: string

使用可能な値: [ "artifact", "httppost" ]

使用するSAML 2.0 SSOプロファイル
ssoSOAPURL: string

SPがSSOアーティファクト・プロファイルにおいてSOAPリクエストを送信するSAML 2.0シングル・サインオン・サービスのSOAP URL
ssoURL: string

ユーザーがリダイレクト・プロファイルによるSAML 2.0 AuthnRequestでSPによりリダイレクトされるSAML 2.0シングル・サインオン・サービスURL
succinctID: string

ProviderIDのSHA-1ハッシュ
tenantName: string

ターゲット・サービスにおける顧客のテナント名。たとえば、顧客ACME CorpがPaaSではacmeとして、Taleoではacmecorpとして認識されているということがあります。(OIFでマルチ・テナントが有効化されている場合にのみ使用されます)。
tenantURL: string

顧客のテナントURLパス。(OIFでマルチ・テナントが有効化されている場合にのみ使用されます)
validityNewKeys: string

自己署名証明書の有効日数を示します

{
    "description":"Data-Set of IDP Partner",
    "type":"object",
    "properties":{
        "metadataB64":{
            "type":"string",
            "description":"the Base64 encoded metadata of the IdP server that will be sent to the SP. If not specified, idpmetadataurl will be used. If missing, the assertionConsumerServiceArtifactURL, assertionConsumerServicePOSTURL, logoutRequestURL, logoutResponseURL, signingCert and encryptionCert fields must be set, otherwise those fields will be ignored"
        },
        "metadataURL":{
            "type":"string",
            "description":"URL where the IdP metadata can be downloaded"
        },
        "partnerType":{
            "type":"string",
            "description":"Partner Type",
            "enum":[
                "idp"
            ]
        },
        "tenantName":{
            "type":"string",
            "description":"the customer's tenant name in the targeted service. For example, the customer ACME Corp might be known in PaaS as acme and in Taleo as acmecorp. (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)"
        },
        "partnerName":{
            "type":"string",
            "description":"the partner name to be used"
        },
        "nameIDFormat":{
            "type":"string",
            "description":"the NameID format used during Federation SSO, emailaddress or unspecified. 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":[
                "artifact",
                "httppost"
            ]
        },
        "attributeLDAP":{
            "type":"string",
            "description":"indicates if mapping of the Assertion will be done via a SAML Attribute. This parameter indicates the LDAP attribute to use. attributeLDAP and attributeSAML are both required for SAML attribute mapping to work. If specified, nameIDFormat is ignored for assertion mapping"
        },
        "attributeSAML":{
            "type":"string",
            "description":"indicates if mapping of the Assertion will be done via a SAML Attribute. This parameter indicates the SAML attribute to use. attributeLDAP and attributeSAML are both required for SAML attribute mapping to work. If specified, nameIDFormat is ignored for assertion mapping"
        },
        "faWelcomePage":{
            "type":"string",
            "description":"the default relay state to set in that IdP partner entry"
        },
        "generateNewKeys":{
            "type":"string",
            "description":"indicates whether or not new keys and corresponding self signed certificates should be generated for SAML operations, 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":"boolean",
            "description":"will test the data-set of idp partner but will not create the actual partner if set to 'true'"
        },
        "providerID":{
            "type":"string",
            "description":"the IdP'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":"the SAML 2.0 Single Sign-On service SOAP URL where the SP will send a SOAP request during the SSO Artifact profile"
        },
        "logoutRequestURL":{
            "type":"string",
            "description":"the URL that will be used by the SP to redirect the user to the IdP for the Logout Redirect profile with the SAML"
        },
        "logoutResponseURL":{
            "type":"string",
            "description":"the URL that will be used by the SP to redirect the user to the IdP for the Logout Redirect profile with the SAML LogoutResponse"
        },
        "assertionConsumerURL":{
            "type":"string",
            "description":"the URL that will be used by the IdP to redirect the user to the SP for the SSO Artifact profile with the SAML Artifact"
        },
        "succinctID":{
            "type":"string",
            "description":"the SHA-1 hash of the ProviderID"
        },
        "signingCert":{
            "type":"string",
            "description":"the Base64 encoded X.509 Signing Certificate used by the IdP to sign messages or assertions"
        },
        "encryptionCert":{
            "type":"string",
            "description":"the Base64 encoded X.509 Encryption Certificate used by the IdP to decrypt encrypted SAML messages"
        },
        "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":"adminFedInstanceType for the IDP Partner"
        }
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: 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レスポンス

内部サーバー・エラー。

先頭に戻る