Set idle session expiration time

Prev Next

Available in Classic and VPC

Set the sub account idle session expiration time. If no activity is performed on the sub account for the set period of time, it will be automatically logged out.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/tenant-settings/sub-account-session-policy

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
useSessionExpiration Boolean Required Whether to set the idle session expiration time
  • true | false
    • true: set
    • false: not set
sessionExpirationSec Integer Conditional Idle session expiration time (second)
  • 600 | 1800 | 3600 | 10800
  • Required if useSessionExpiration is true

Request example

The request example is as follows:

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
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API call success status
  • true | false
    • true: succeeded
    • false: failed

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

{
    "success": true
}