Which parameter controls REST API Token time out?

Version 1
    Share This:

    This document contains official content from the BMC Software Knowledge Base. It is automatically updated when the knowledge article is modified.


    PRODUCT:

    Remedy AR System Server


    COMPONENT:

    AR System Server


    APPLIES TO:

    ARS 9.1 or later;1902 ;1908



    QUESTION:

    Which parameter controls Remedy REST API Token time out?


    ANSWER:

    For 9.1.00 ...Till 9.1.05 ( includes 1802 , 1805 )   Release:

    The JWT token expiry is governed by configuration parameter “External-Authentication-Sync-Timeout” in the ar.cfg file. 
    Default value of this parameter is 3600 seconds. There is no max limit. If you set this value to 0 then it will go to the default 3600 seconds as well.  REST API tokens will expire at whatever value is set in this parameter.

    For 1808 / 1902 and forward releases :

    With former remedy releases we have a separate parameter to control the specific restapi session and we do not need to change complete external authentication sync timeout .

    It is recommended to perform configuration in the Centralized Configuration under the correct component name. Manually adding these parameters to ar.cfg/conf may not work .

    Under centralized configuration console in AR system Administration settings

    1) Select com.bmc.arsys.server.shared component settings.

    2) Add Rest-Authentication-Token-Timeout  , the value is to be specified in seconds . For instance for 2 hours of timeout for restapi user session customer can set Rest-Authentication-Token-Timeout as 7200 .

     


    Article Number:

    000156892


    Article Type:

    FAQ/Procedural



      Looking for additional information?    Search BMC Support  or  Browse Knowledge Articles