Space banner


This space provides the same content as before, but the organization of the home page has changed. The content is now organized based on logical branches instead of legacy book titles. We hope that the new structure will help you quickly find the content that you need.

Logging out of the Common REST API

To log out of a session that is open in the Common REST API, use the following URL:


  1. Set the variables to the following values:
    • <hostName> is the name of the mainframe host where the Tomcat server is running.
    • <portNumber> is the port number of the Tomcat server.
    • <serviceName> is the name of the service as it appears on the list. For more information, see To retrieve a list of services.
  2. Set the Authorization header type to Basic Auth. Set Username and Password to your mainframe user credentials for accessing Tomcat. This user must have the required SAF permission defined.
  3. In the Header, set the Content-Type to application/x-www-form-urlencoded
  4. In the Body, set the following key: 
    <userToken> is the token issued to you when you logged on. For more information, see Logging in to a service using the Common REST API


If you do not log out, the user token expires after the period of inactivity that the timeout value defines.  The default timeout value is 15 minutes. For more information, see Managing Common REST API session tokens and user tokens.

Was this page helpful? Yes No Submitting... Thank you