Specifying authentication information

Use the information described in this topic to know how authentication information is specified for a published web service and for consuming a web service.

Specifying authentication information for a published web service

When you publish a web service, the consuming application can specify which user is authorized to perform the web service operations. AR System server checks whether the SOAP header contains the root XML data type AuthenticationInfo. This is an AR SystemXML data type and consists of the child elements userName, password, authentication, locale, and timeZone. The timeZone child element is optional. When the AuthenticationInfo data type is included in the SOAP header, it should look like the following example:

Related topics

Configuring-SOAP-headers-and-authentication-for-web-services

Mapping-XML-data-types


<AuthenticationInfo>
<userName>Joe</userName>
<password>ILoveDogs</password>
<authentication>ARSystem</authentication>
<locale>en_US</locale>
<timeZone> </timeZone>
</AuthenticationInfo>

The locale and time zone information are a part of the standard authentication parameters that are used by the AR System. However, currently, the AR Systemuses locale information only for converting error messages.

If the authentication information is not specified, AR System server uses the Anonymous User Name and Anonymous Password defined in Mid TierConfiguration Tool.

Web_services.png

You can use any name as the Anonymous User Name for development purposes, but for production, create a user name specific to the published web service.

Specifying authentication information for consuming a web service

When you create a workflow to consume an AR System server or external web service that requires a SOAP header, Developer Studiochecks the SOAP header elements specified in the WSDL. If the WSDL specifies the SOAP header elements, Developer Studioautomatically creates a SOAPHeader element under the ROOT element. To communicate with any web service that requires authentication, you must use the Input Mapping table to map the source of the user name and password in the web services workflow.

When you add a Set Fields action to a filter or escalation and select WEB SERVICE as the data source, the Authentication field appears. Use this field to define the authentication type required for the web service. The options are:

  • None—The web service does not require authentication.
  • Custom—The external web service must be designed to recognize the fields that contain the user name and password. The SOAPHeader is not used to carry the user name and password. The password is sent unencrypted.
  • AR Authentication—The web service is provided by an AR System server. This option uses the AR SystemAuthenticationInfo data type in the SOAP header. The password is sent unencrypted.
  • Username Token—The web service is an external web service that supports WS-Security Username Token 1.0. (Web Services that use Username Token 1.1 can be used, if they support 1.0 as well.) The password can be sent either as plain text or as a digest as specified in the WS-Security specification.
Important

AuthenticationInfo is BMC reserve tag. Do not use a tag with AuthenticationInfo name inside a SOAP header tag.
If you use this tag, the required information may not pass to the web service.

The following screenshot shows an example of selecting Username Token as an authentication type:

WSDL-Example.png

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*