Set Idle Session Timeout

Changes the session timeout (in minutes) of the Oracle Fusion Cloud EPM environment. The new session timeout becomes active after the next daily maintenance of the environment.

Use this API to change the default session timeout (75 minutes) to a different value (4 - 480 minutes). After a session is idle for the duration specified using this API, the user is redirected to the Login page.

Note:

You can also set the idle session timeout at the identity domain level. The effective timeout is the shorter of the identity domain timeout and the environment-level timeout. When a session remains idle for that period, the user is redirected to the Login page. See Changing the Session Time-Out in the Oracle Cloud Infrastructure Documentation for instructions to set the timeout at the domain level.

This API is version v2.

Required Roles

Service Administrator

REST Resource

PUT /interop/rest/{api_version}/config/services/idlesessiontimeout

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for Cloud EPM REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Request

Supported Media Types: application/json

Table 9-37 Parameters

Name Description Type Required Default
api_version Specific API version (v2) Path Yes None
timeout Session timeout value Payload Yes None

Example of Request Body

{
  "timeout": "15"
}

Response

Supported Media Types: application/json

Table 9-38 Parameters

Name Description
details In case of errors, details are published with the error string
status
  • 0 - Operation success
  • +ve - Operation failed, with the status signifying an error
href Link to API call
action HTTP call type
rel Possible value: self
data null

Example of Response Body

{
       "links": [{
             "rel": "self",
             "href": "<uri>/interop/rest/v2/config/services/idlesessiontimeout",
             "data": null,
             "action": "PUT"
       }],
       "details": "null",
       "status": 0,
       "items": null
}

Sample cURL command

curl -X PUT -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json' -d 
'{"timeout":"30"}' 'https://<BASE-URL>/interop/rest/v2/config/services/idlesessiontimeout