Set idle session expiration time
    • PDF

    Set idle session expiration time

    • PDF

    Article summary

    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:

    MethodURI
    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:

    FieldTypeRequiredDescription
    useSessionExpirationBooleanRequiredWhether to set the idle session expiration time
    • true | false
      • true: set
      • false: not set
    sessionExpirationSecIntegerConditionalIdle 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:

    FieldTypeRequiredDescription
    successBoolean-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
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.