Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  CloudCX LOGOUT API

    Posted 10-09-2025 00:57
    Hi,
    We are working on a custom service with a feature to logoff users and release their license that was checked out during login.
     
    From the Performance > Agent Status page, we could see a "logoff" option on the CloudCX UI which in the background invokes the logout API mentioned below.
     
    curl --request DELETE \
    --header 'authorization: Bearer ***********'
     
    As a result of this API invocation, we could see that the agent is logged out and moved to Offline state.
    Can we use this API at all ? as it is not documented in API Explorer.
    If not, kindly suggest how the logout functionality can be handled.

    #PlatformAPI

    ------------------------------
    Thanks.
    ------------------------------


  • 2.  RE: CloudCX LOGOUT API

    Posted 10-10-2025 22:51

    Hi, 

    From my tests, that endpoint seems to be part of the backend and not a public API. Since it's not listed in the API Explorer, I'd assume it's not officially supported and could change without notice.

    What worked for me was using the documented endpoint that revokes user tokens and forces a disconnect:
    DELETE /api/v2/tokens/{userId}

    If the user is in a browser session, you can also try redirecting to:
    https://login.<region>/logout

    I'd also suggest checking whether the automatic inactivity timeout meets your needs for handling idle logouts.



    ------------------------------
    Luiz Rosa
    Full stack developer
    ------------------------------