アイドルセッションタイムアウトの設定

Prev Next

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

サブアカウントのアイドルセッションタイムアウト値を設定します。設定した時間の間、サブアカウントで何の操作もしなければ、自動的にログアウトされます。

リクエスト

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

メソッド URI
POST /api/v1/tenant-settings/sub-account-session-policy

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
useSessionExpiration Boolean Required アイドルセッションタイムアウト値を設定するかどうか
  • true | false
    • true: 設定
    • false: 設定しない
sessionExpirationSec Integer Conditional アイドルセッションタイムアウト(秒)
  • 600 | 1800 | 3600 | 10800
  • useSessionExpirationtrueの場合は必ず入力

リクエスト例

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

curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/tenant-settings/sub-account-session-policy' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "useSessionExpiration": true,
    "sessionExpirationSec": 600
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
success Boolean - API呼び出しに成功したかどうか
  • true | false
    • true: 成功
    • false: 失敗

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

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

レスポンス例

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

{
    "success": true
}