External IdPの照会

印刷する
共有
PDF

記事の要約

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

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

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

External SAML IdPを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/tenant/saml-idp

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/tenant/saml-idp' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`signRequest`	Boolean	-	AuthnRequestに署名するかどうか `true` \| `false` `true`: 署名 `false`: 署名しない
`providerId`	String	-	IdPの固有 ID
`idpSigninUrl`	String	-	ユーザーが SSOでログインする際にリダイレクトされる IdPのログイン URL
`idpIssuerUrl`	String	-	SAMLレスポンスで発行者(Issuer)として使用される URL
`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リクエストで送信する方法
`idpCert`	String	-	SAMLレスポンスの署名を検証するのに使われる IdPの公開証明書
`idpCertExpAt`	String	-	IdP証明書の期限切れ日時 ISO 8601形式

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

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

レスポンス例

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

{
    "signRequest": false,
    "providerId": "54c6bad4-****-****-****-e768030ebd25",
    "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",
    "signResponseAlgorithm": "SHA-1",
    "protocolBinding": "HTTP-POST",
    "idpCert": "MIID**********q1QPA==",
    "idpCertExpAt": "2030-01-20T03:01:54Z"
}

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

What's Next

External IdPの作成

リクエスト
レスポンス