Deactivate long-term unused sub account

Prev Next

Available in Classic and VPC

Set the deactivation period for long-term inactivity of sub accounts. If the number of days a sub account remains inactive exceeds the set deactivation period, the sub account will be deactivated.

Request

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

Method URI
POST /api/v1/tenant-settings/idle-disable-settings

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
useIdleDisable Boolean Required Whether to deactivate unused sub accounts
  • true | false
    • true: Enable
    • false: Disable
idleDisableDays Integer Conditional Unused sub account period setting (day)
  • 90 | 180 | 365
  • Required if useIdleDisable is true

Request example

The request example is as follows:

curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/tenant-settings/idle-disable-settings' \
--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 '{
    "useIdleDisable": true,
    "idleDisableDays": 90
}'

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
}