PI24525: UPDATES NEEDED FOR "AUTHENTICATING WITH A SESSION KEY" HELP

IBM UrbanCode Deploy 6.1.1
IBM UrbanCode Deploy Fix Pack 1 (6.1.1.1) for 6.1.1
IBM UrbanCode Deploy Fix Pack 2 (6.1.1.2) for 6.1.1
IBM UrbanCode Deploy Fix Pack 3 (6.1.1.3) for 6.1.1
IBM UrbanCode Deploy Fix Pack 4 (6.1.1.4) for 6.1.1
IBM UrbanCode Deploy Fix Pack 5 (6.1.1.5) for 6.1.1
IBM UrbanCode Deploy Fix Pack 6 (6.1.1.6) for 6.1.1
IBM UrbanCode Deploy Fix Pack 7 (6.1.1.7) for 6.1.1
IBM UrbanCode Deploy Fix Pack 8 (6.1.1.8) for 6.1.1
IBM UrbanCode Deploy iFix 1 for 6.1.1.7
IBM UrbanCode Deploy iFix 2 for 6.1.1.8

APAR status

• Closed as documentation error.

Error description

• The paragraph: "Authenticating with a session key" in the
  following Knowledge center page:
  
  
  http://www-01.ibm.com/support/knowledgecenter/SS4GSP_6.1.0/com.i
  bm.udeploy.reference.doc/topics/rest_api_ref_authenticating.html
  ?lang=en
  
  
  should be replaced by a more detailed description, such as:
  
  
  In order to perform PUT, POST and DELETE REST calls, some client
  programs may need to use a session key (a cookie named
  UCD_SESSION_KEY).
  
  This depends on whether the client program sends the
  "User-Agent" Header with the request.
  If the client program presents itself as a browser using
  "User-Agent", then the session key is required.
  For example, it is required when using Microsoft Visual Basic
  For Applications (and the object type: WinHttp.WinHttpRequest).
  
  
  For the initial request, be it GET, PUT, POST, DELETE methods,
  the UCD_SESSION_KEY is not necessary as the program is expected
  to authenticate using Basic Authentication.
  
  After the initial request, for any additional PUT, POST, DELETE
  requests in the same session, UrbanCode Deploy gets the user
  from the request's session and then attempts to use the cookie
  to verify that user's identity.
  
  
  
  To obtain a session key, the client program needs to first
  perform Basic Authentication and then issue a valid request.
  
  The client program must inspect the response headers from the
  initial request, and then find the value of the request header
  that contains the string UCD_SESSION_KEY.
  
  This header typically has the name:
  Set-Cookie
  and a value like:
  UCD_SESSION_KEY=6286eb44-b867-4435-875b-e61c5d8b4301;
  Expires=Wed, 09-Sep-2082 16:51:45 GMT; Path=/; Secure
  
  Using the above example, the program will have to extract the
  value sessionKey=6286eb44-b867-4435-875b-e61c5d8b4301.
  
  Then, the program can use that session key to authenticate for
  subsequent PUT, POST and DELETE REST commands.
  
  For example, you might add the following header to the
  subsequent PUT, POST and DELETE requests:
  
  UCD_SESSION_KEY:sessionKey
  

Local fix

• Refer to the above updated information.
  

Problem summary

• ****************************************************************
  * USERS AFFECTED:                                              *
  * All users of IBM UrbanCode documentation                     *
  ****************************************************************
  * PROBLEM DESCRIPTION:                                         *
  * UPDATES NEEDED FOR "AUTHENTICATING WITH A SESSION KEY" HELP  *
  ****************************************************************
  * RECOMMENDATION:                                              *
  ****************************************************************
  

Problem conclusion

• Documentation updated in IBM UrbanCode Deploy 6.1.1
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

Applicable component levels