External IdPの更新

印刷する
共有
PDF

記事の要約

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

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

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

External SAML IdPを更新します。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

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

リクエスト例

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

curl --location --request PUT '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}' \
--data '{
    "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" : "{Certificate}",
    "signResponseAlgorithm" : "SHA-1",
    "protocolBinding" : "HTTP-POST"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`message`	String	-	結果メッセージ `success`が`false`の場合、表示

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

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

レスポンス例

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

{
    "success": true
}

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

What's Next

External IdPの削除

リクエスト
レスポンス