External IdPログインの設定
- 印刷する
- PDF
External IdPログインの設定
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
External IdPのログイン情報を設定します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
PUT | /api/v1/tenant/login-settings |
リクエストヘッダ
Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
idleSessionExpDuration | Integer | Required | ログインした外部アカウントのセッションタイムアウト(秒)
|
multipleLoginAllowed | Boolean | Required | 重複ログインを許可するかどうか
|
possessionAuthenticationEnabled | Boolean | Required | 占有認証を適用するかどうか
|
possessionAuthenticationTypes | Array | Required | 占有認証方法タイプ
|
multiFactorAuthenticationEnabled | Boolean | Required | 2段階認証を適用するかどうか
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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処理結果
|
message | String | - | 結果メッセージ
|
レスポンスステータスコード
Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"success": true
}
この記事は役に立ちましたか?