This is an inbound web service invoked by remote systems on Universal Access. It is used to link a Citizen Workspace Account to a remote system. See the section on Create Account Service for a general discussion of the implications of linking a user. The schema for the payload of web service requests of this type can be found in <CURAM_DIR>\EJBServer\components\WorkspaceServices\webservices\ExternalAccountLink.xsd. A sample SOAP request for this web service is published in Appendix A.
This web service request contains the following information:
- sourceSystem – The name of the remote system sending the request. Must match the name of a remote system configured in the system.
- citizenWorkspaceAccountID – The unique citizen workspace account id.
- clientIDOnRemoteSystem - This is a unique identifier that can be used to identify the user of this account on the remote system. There is no prescribed form for this id, it could be a Social Security Number for example. It must be capable of uniquely identifying the client on the remote system.
- createdByUsername – The username on the remote system responsible for this request.
On success this operation returns a document indicating that the request has succeeded. On failure, a fault is raised. Reasons for failure include:
- The citizen workspace account id is invalid, does not exist or is associated with a de-activated account.
- The citizen workspace account in question is already linked to this remote system.