ZZ00214: HOW TO SPECIFY DOMAIN NAME TO AUTHENTICATE WITH IWD REST API

IBM SmartCloud Orchestrator Fix Pack 1 (2.3.0.1) for 2.3

APAR status

• Closed as documentation error.

Error description

• Problem Description:
  
  The customer wants to use Virtual system instances REST API
  at the following URL.
  
  http://pic.dhe.ibm.com/infocenter/tivihelp/v48r1/topic/com.ibm.s
  co.doc_2.3/ra/rar_virt_systems.html
  
  The customer is confirming the way to use the API.
  And the customer confirmed the user that is belonging to Default
  domain
  can authenticate by Basic authentication.
  But, the customer confirmed the user that is not belonging to
  Default
  domain can not authenticate.
  
  So, could you please tell me the way to specify domain when the
  user
  that is not belonging to Default domain authenticates ?
  
  
  Missing information to the documentation:
  
  ----------
  The way to specify a specific domain or project is as follows:
  
  curl -u myuser:password -k -H "domainName:mydomain" -H
   "projectName:myproject" -H
  "X-IBM-Workload-Deployer-API-Version:4.0.0
  .1" -H "Content-Type:application/json"
   https://192.168.35.3/virtualSystem/1
  
  so you have to specify in the header domainName and projectName.
  ----------
  

Local fix

• no workaorund
  

Problem summary

• ****************************************************************
  * USERS AFFECTED: All users of SmartCloud Orchestrator 2.3 using
  * REST APIs
  ****************************************************************
  * PROBLEM DESCRIPTION:
  * Missing documentation on how to specify domain name and
  * project name when using REST APIs
  ****************************************************************
  * RECOMMENDATION:
  Review the next update of SmartCloud Orchestrator 2.3
  Information Center when available.
  
  The documentation changes can also be found in the conslusion
  section below
  

Problem conclusion

• In addition to the information already provided at
  http://pic.dhe.ibm.com/infocenter/tivihelp/v48r1/index.jsp?topic
  =%2Fcom.ibm.sco.doc_2.3%2Fra%2Frat_overview.html
  
  the following headers need to be specified in case you do not
  want to use the default project name and domain name:
  
  domainName:<yourDomainName>
  
  and
  
  projectName:<yourProjectName>
  
  Example:
  
  curl -u myuser:password -k -H "domainName:mydomain" -H
   "projectName:myproject" -H
  "X-IBM-Workload-Deployer-API-Version:4.0.0.1"
  -H "Content-Type:application/json"
   https://mySCOIP/virtualSystem/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