SecurityProvider

You can use the SecurityProvider web service to access the SunSystems Security Component. The Authenticate, Validate, UserPropertyValue and GlobalPropertyValue methods are supported by the web service.

When using SOAP protocol testing tools, you must ensure that any manually constructed SOAP envelopes escape the SSC Payload data. This must be either by XML escaping or by CDATA blocks, as in this example:

Note: The URL http://<servername>/sunsystems-connect/soap/SecurityProvider must be transmitted to the SSC SOAP API.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://systemsunion.com/connect/webservices/">
  <soapenv:Body>
    <web:SecurityProviderAuthenticateRequest>
      <web:name>PK1</web:name>
      <web:password></web:password>
    </web:SecurityProviderAuthenticateRequest>
  </soapenv:Body>
</soapenv:Envelope>

You can use developer tools to generate a programming language-specific binding against the URL http://<servername>/sunsystems-connect/wsdl/SecurityProvider.

Authenticate

The Authenticate method is used to obtain an authentication voucher for an operator. If the credentials passed to this method are valid then the method returns a string containing an authentication voucher.

string Authenticate(
    string name,                //the operator name
    string password             //the operator password
)

Validate

The Validate method validates an authentication voucher. If the voucher is valid then the method returns true, otherwise it returns false.

boolean Validate(
    string authentication       //an authentication voucher
)

UserPropertyValue

The UserPropertyValue method returns a string containing the value of a user property. The method returns a null value if the authentication is invalid or the property does not exist.

string UserPropertyValue(
    string authentication,      //an authentication voucher
    string property             //the property name
)

GlobalPropertyValue

The GlobalPropertyValue method returns a string containing the value of a global property. The method returns a null value if the authentication is invalid or the property does not exist. Some global properties require a password in order to be accessed. In this case a valid password must be provided in the password parameter.

string GlobalPropertyValue(
    string authentication,      //an authentication voucher
    string property,            //the property name
    string password             //a property password can be null
)