External IdPメタデータのパース

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

External SAML IdPのメタデータをパースします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/tenant/saml-idp/metadata-parsing

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`EntityDescriptor.xmlns:md`	String	Required	XML namespace情報 `urn:oasis:names:tc:SAML:2.0:metadata` (有効値)
`EntityDescriptor.entityID`	String	Required	IdPエンティティの固有 ID
`EntityDescriptor.IDPSSODescriptor.WantAuthnRequestsSigned`	Boolean	Optional	AuthnRequestに署名するかどうか `true` \| `false` `true`: 署名 `false`: 署名しない
`EntityDescriptor.IDPSSODescriptor.protocolSupportEnumeration`	String	Required	サポートするプロトコル `urn:oasis:names:tc:SAML:2.0:protocol` (有効値)
`EntityDescriptor.IDPSSODescriptor.KeyDescriptor.use`	String	Required	証明書の用途 `signing` (有効値)
`EntityDescriptor.IDPSSODescriptor.KeyDescriptor.KeyInfo.xmlns:ds`	String	Required	KeyInfo namespace情報 `http://www.w3.org/2000/09/xmldsig#` (有効値)
`EntityDescriptor.IDPSSODescriptor.KeyDescriptor.KeyInfo.X509Data.X509Certificate`	String	Required	IdP署名用 X.509証明書
`EntityDescriptor.IDPSSODescriptor.SingleSignOnService.Binding`	String	Required	SAMLログイン時のプロトコルバインディング情報 `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` \| `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect` `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST`: HTTP-POST方式 `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect`: HTTP-Redirect方式
`EntityDescriptor.IDPSSODescriptor.SingleSignOnService.Location`	String	Required	バインディングプロトコルとマッピングする SAMLログイン URL

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/tenant/saml-idp/metadata-parsing' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/xml' \
--data '<?xml version="1.0" encoding="UTF-8"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx">
  <md:IDPSSODescriptor WantAuthnRequestsSigned="false" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
    <md:KeyDescriptor use="signing">
      <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
        <ds:X509Data>
          <ds:X509Certificate>MII******************vkhgLE=</ds:X509Certificate>
        </ds:X509Data>
      </ds:KeyInfo>
    </md:KeyDescriptor>
    <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://portal.sso.ap-southeast-2.amazonaws.com/saml/logout/MDUwNzUy****************************ZTU0NTkx"/>
    <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://portal.sso.ap-southeast-2.amazonaws.com/saml/logout/MDUwNzUy****************************ZTU0NTkx"/>
    <md:NameIDFormat/>
    <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx"/>
    <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx"/>
  </md:IDPSSODescriptor>
</md:EntityDescriptor>'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`signRequest`	Boolean	-	AuthnRequestに署名するかどうか `true` \| `false` `true`: 署名 `false`: 署名しない
`providerId`	String	-	IdPの固有 ID
`idpSigninUrl`	String	-	ユーザーが SSOでログインする際にリダイレクトされる IdPのログイン URL
`idpIssuerUrl`	String	-	SAMLレスポンスで発行者(Issuer)として使用される URL
`idpCert`	String	-	SAMLレスポンスの署名を検証するのに使われる IdPの公開証明書
`signRequestAlgorithm`	String	-	SAMLリクエスト署名時に使用するハッシュアルゴリズム `signRequest`が`true`の場合、表示 `SHA-1` \| `SHA-256` `SHA-1`: SHA-1ハッシュアルゴリズム `SHA-256`: SHA-256ハッシュアルゴリズム
`signResponseAlgorithm`	String	-	SAMLレスポンス署名時に使用するハッシュアルゴリズム `SHA-1` \| `SHA-256` `SHA-1`: SHA-1ハッシュアルゴリズム `SHA-256`: SHA-256ハッシュアルゴリズム
`protocolBinding`	String	-	SAMLリクエストとレスポンスを送信する際に使用するプロトコルバインディング `HTTP-POST` \| `HTTP-REDIRECT` `HTTP-POST`: SAMLメッセージを HTTP-POSTリクエストの本文に含めて送信する方法 `HTTP-REDIRECT`: SAMLメッセージを URLクエリパラメータとして含めて HTTP-GETリクエストで送信する方法

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "signRequest": false,
    "idpSigninUrl": "https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx",
    "idpIssuerUrl": "https://portal.sso.ap-southeast-2.amazonaws.com/saml/assertion/MDUwNzUy****************************ZTU0NTkx",
    "idpCert": "MII******************vkhgLE=",
    "signResponseAlgorithm": "SHA-256",
    "protocolBinding": "HTTP-POST"
}

この記事は役に立ちましたか?

What's Next

Ncloud Single Sign-Onメタデータの照会

リクエスト
レスポンス