Save instance session idle-stop settings (superadmin, configured step-up)

PUT

/v1/system/session-idle

curl --request PUT \
  --url https://example.com/v1/system/session-idle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "idle_stop_minutes": 0 }'

• this engine

Saves the instance idle-stop window: zero turns it off, and 6 to 10080 minutes enables it after the five-minute idle projection. Requires system administration and configured step-up; the change is audited before it applies.

Authorizations

• bearerAuth
• browserSession

Request Body ^required

Media type application/json

object

idle_stop_minutes

required

0 disables auto-stop; enabled values are 6..10080 minutes after the five-minute idle projection. Finished sessions are stopped only with no open view, approval, child, peer or newer message.

integer

0 <= 10080

Responses

200

OK

Media type application/json

object

idle_stop_minutes

required

0 disables auto-stop; enabled values are 6..10080 minutes after the five-minute idle projection. Finished sessions are stopped only with no open view, approval, child, peer or newer message.

integer

0 <= 10080

Example

{
  "idle_stop_minutes": 0
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

503

Session idle settings unavailable

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}