GSO RESTful web service

When configuring the GSO capability for forms single sign-on (FSSO) and basic authentication (BA), specify a GSO resource. To specify the GSO resource if to use a web service to communicate GSO data from an external resource.

[url]{<hostname>:<port>,}<uri>

[url]	A static string that indicates a web service is used for this GSO resource. If a [url] designator is not present, the GSO credential information is retrieved from the ISAM user registry.
<hostname>	The host name to use if the web service is accessed over a virtual host junction.
<port>	The port to use if the web service is accessed over a virtual host junction.
<uri>	The URI to which GSO requests are sent. This URI is relative to the root web space of the local WebSEAL server.

Here is an example resource that communicates with WebSEAL through a web service:

[url]www.ibm.com:80,/gso/credentials

The web service can be used to retrieve or update the credential information for a particular user. To retrieve the GSO data for a particular user, the web service format is as follows:

Method:   GET

URI:      <web-service-root>/<isva-user-name>

Response: A successful response should include a status of 200 OK, with the 
          following JSON data included in the body:
	   * gso-username
	   * gso-password	
          If the credential information is not found, a 404 NOT FOUND response is returned.

To store new credential information for a particular user, the web service format is as follows:

Method:   PUT

URI:      <web-service-root>/<isva-user-name>

Body:     JSON data, which includes the following fields:
	   * gso-username
	   * gso-password
				
Response: A successful response includes a 204 No-Content with an empty body.

To delete the credential information for a particular user, the web service format is as follows:

Method:   DELETE

URI:      <web-service-root>/<isva-user-name>

Response: A successful response includes a 204 No-Content with an empty body.

By default, the passwords that are managed by the GSO RESTful web service are not obfuscated. To obfuscate the passwords, set the gso-obfuscation-key stanza entry in the [junction] stanza to contain the obfuscation key. Setting this stanza entry enables password obfuscation for the GSO RESTful web service.

Parent topic: Global sign-on overview