External IdPの照会

Prev Next

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の公開証明書 (deprecated)
idpCertExpAt String - IdP証明書の有効期限 (deprecated)
  • ISO 8601形式
idpCerts Array - SAMLレスポンスの署名検証に使われる IdPの公開証明書リスト

idpCerts

idpCertsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
certificate String - SAMLレスポンスの署名検証に使われる IdPの公開証明書
expiredAt 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",
    "idpCerts": [{
        "certificate": "MIID**********q1QPA==",
        "expiredAt": "2030-01-20T03:01:54Z"
    }]
}