CSOD Web Services
Total Page:16
File Type:pdf, Size:1020Kb
Cornerstone OnDemand Web Services Inbound User/OU Web Services Technical Specification TABLE OF CONTENTS TABLE OF CONTENTS .................................................................................................................. 2 INTRODUCTION ............................................................................................................................. 3 SUMMARY ...................................................................................................................................... 4 ASSUMPTIONS ............................................................................................................................... 5 ADDITIONAL REQUIREMENTS ..................................................................................................... 6 INITIAL SETUP ............................................................................................................................... 7 TECHNICAL DETAILS .................................................................................................................. 11 TECHNOLOGY .................................................................................................................................. 11 TRANSPORT LEVEL SECURITY .......................................................................................................... 12 AUTHENTICATION AND AUTHORIZATION ............................................................................................. 12 CLIENT DATA SERVICES ............................................................................................................ 15 ECHOOUS ....................................................................................................................................... 17 ECHOUSERS ................................................................................................................................... 21 RECONCILEOUS .............................................................................................................................. 25 RECONCILEUSERS ........................................................................................................................... 27 SETOUS .......................................................................................................................................... 29 SETOULOCAL .................................................................................................................................. 32 SETUSERS ...................................................................................................................................... 38 GETUSER ........................................................................................................................................ 43 DATA DICTIONARY ...................................................................................................................... 49 ORGANIZATIONAL UNIT .................................................................................................................... 49 LOCATION ....................................................................................................................................... 50 USERS ............................................................................................................................................ 51 LOAD AND TEST .......................................................................................................................... 56 USERS ............................................................................................................................................ 56 OU HIERARCHIES ............................................................................................................................ 56 REPORTS ........................................................................................................................................ 57 APPENDIX .................................................................................................................................... 58 APPENDIX A – TIME ZONES .............................................................................................................. 58 APPENDIX B – COUNTRY CODES (ISO 3166-1) ................................................................................. 62 APPENDIX C – ERRORS .................................................................................................................... 66 APPENDIX D – LANGUAGE CODES .................................................................................................... 67 INTRODUCTION The client data web services API is for clients seeking a way, to create and update users and organizational units’ records in the Cornerstone Talent Management System, directly from their system through web services. Cornerstone Web Services Architecture: STRICTLY CONFIDENTIAL / TECHNICAL SPECIFICATION 3 1601 Cloverfield Blvd., Suite #620 - Santa Monica, CA 90404 – USA Tel: (310) 752-0200 Fax: (310) 752-0199 Email: [email protected] Website: www.CornerstoneOnDemand.com SUMMARY This document gives a technical description of the following web service: CLIENT DATA SERVICE: EchoOus Send Organizational Units' payload and have it echoed back, validates XML payload against schema without loading into the system. EchoUsers Send Users payload and have it echoed back, validates XML payload against schema without loading into the system. ReconcileOus Deactivates Organizational Units based on latest modification date and allow reconcile flag set in the system. ReconcileUsers Deactivates Users based on latest modification date and allow reconcile flag set in the system. SetOus Create / Update Orgnanizational Units in the Cornerstone system. SetOuLocal Create / Update Orgnanizational Units in the Cornerstone system. SetUsers Create / Update Users in the Cornerstone system. GetUser Retrieve User data from the Cornerstone system. STRICTLY CONFIDENTIAL / TECHNICAL SPECIFICATION 4 1601 Cloverfield Blvd., Suite #620 - Santa Monica, CA 90404 – USA Tel: (310) 752-0200 Fax: (310) 752-0199 Email: [email protected] Website: www.CornerstoneOnDemand.com ASSUMPTIONS The web service is made available at the specified URL and no client software is offered for its use. Developers can use this document as a guide to develop code to consume Cornerstone On Demand web services. It assumes that he or she is familiar with the following technologies: XML (eXtensible Markup Language) XSD (XML Schema Definition) Web Services technology WS Security STRICTLY CONFIDENTIAL / TECHNICAL SPECIFICATION 5 1601 Cloverfield Blvd., Suite #620 - Santa Monica, CA 90404 – USA Tel: (310) 752-0200 Fax: (310) 752-0199 Email: [email protected] Website: www.CornerstoneOnDemand.com ADDITIONAL REQUIREMENTS The following are additional requirements associated to the User/OU web service: XML files must be in UTF-8 format. Blanks do not replace values: If a field in the request XML is blank (empty), that blank will not replace the existing value in the system. The existing value in the system will remain even after the request XML is processed. STRICTLY CONFIDENTIAL / TECHNICAL SPECIFICATION 6 1601 Cloverfield Blvd., Suite #620 - Santa Monica, CA 90404 – USA Tel: (310) 752-0200 Fax: (310) 752-0199 Email: [email protected] Website: www.CornerstoneOnDemand.com INITIAL SETUP The web service account, which is the account that will be used in the authentication of the User/OU web services, should be setup prior to utilizing the web service. This setup will create a web service account, assign the web service account to a Division that does not have password expiration (if you do not want the web service account password to expire), place the web service account into the WS Administrator security role, and will create a password for the web service account. Failure to follow the below steps may result in the inability to make web service calls or cause the web service to cease after a certain period of time. Step 1 – Contact your CSOD integration consultant to enable the web services security object. Without it being enabled, the web services will not function. Step 2 – Login to your portal with administrator privileges. Step 3 – Via Admin->Users->Add User, create the web service account. From the system perspective, this is just another user account. i. The User ID and Username must be of a value currently not used by any other user account in the system (must be unique). ii. The web service account must be Active. iii. The web service account must have “Allow Reconciliation” de-activated. iv. After entering in all of the necessary information in the user profile page, click the “Save” button. v. Proceed to then set the user’s password. STRICTLY CONFIDENTIAL / TECHNICAL SPECIFICATION 7 1601 Cloverfield Blvd., Suite #620 - Santa Monica, CA 90404 – USA Tel: (310) 752-0200 Fax: (310) 752-0199 Email: [email protected] Website: www.CornerstoneOnDemand.com Step 4 – Assign the web service account to a Division that does not have password expiration. If you do not want the account password to expire, then you must assign the web service account to a Division that does not have password expiration. NOTE: if the web service account password expires, the web service would cease to function. Here are the steps in assigning the web service account to a Division that does not have password expiration. i. Via Admin->Users, go to the web service account user profile. ii. Scroll down to where