External IdPログインの設定

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

External IdPのログイン情報を設定します。

リクエスト

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

メソッド	URI
PUT	/api/v1/tenant/login-settings

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`idleSessionExpDuration`	Integer	Required	ログインした外部アカウントのセッションタイムアウト(秒) `600` \| `1800` \| `3600` \| `10800`
`multipleLoginAllowed`	Boolean	Required	重複ログインを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない重複ログインを許可しない場合、SSOロールごとに1つのセッションのみ接続可能
`possessionAuthenticationEnabled`	Boolean	Required	占有認証を適用するかどうか `true` \| `false` `true`: 適用 `false`: 適用しない `multiFactorAuthenticationEnabled`が`true`の場合、`false`は入力不可占有認証を適用する場合、NAVERクラウドプラットフォームで SSO Userの認証済みメール/SMS情報の登録・管理が可能
`possessionAuthenticationTypes`	Array	Required	占有認証方法タイプ `SMS` \| `Email` `SMS`: SMS `Email`: メール両方入力可能
`multiFactorAuthenticationEnabled`	Boolean	Required	2段階認証を適用するかどうか `true` \| `false` `true`: 適用 `false`: 適用しない 2段階認証を適用する場合、SSO Userのログイン時に IDとパスワードを入力した後、メール/SMS/OTPの中から選択して追加認証を行う

リクエスト例

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

curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/tenant/login-settings' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "idleSessionExpDuration": "600",
    "multipleLoginAllowed": true,
    "possessionAuthenticationEnabled": true,
    "possessionAuthenticationTypes": [
        "SMS",
        "Email"
    ],
    "multiFactorAuthenticationEnabled": true
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "success": true
}