Get idle session expiration time

Prev Next

Available in Classic and VPC

Get the sub account idle session expiration time.

Request

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

Method URI
GET /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 example

The request example is as follows:

curl --location --request GET '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'

Response

This section describes the response format.

Response body

The response body includes the following data:

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

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:

{
    "useSessionExpiration": true,
    "sessionExpirationSec": 600
}