Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

  • HTTP basic authentication over SSL
  • WS-Security username token
  • Session based authentication

Given below is an example of invoking an admin service using a SOAP client.

Example: accessing the key validate service of the API Manager

The steps below show , through an example, how to invoke a selected admin service that the UserAdmin Web service, which is secured with the HTTP basic authentication mechanism . We use the UserAdmin as the admin service (you can also use a different admin service (there are other admin service as well, such as ServiceAdmin, StatisticsAdmin, ProxyAdmin etc.) and To invoke the service, we use the soapUI (4.5.1 or later) to invoke it.

  1. Open https://localhost:9443/services/UserAdmin?wsdl in your browser to check if it is accessible.

    Note

    By default, the WSDLs of admin services is hidden from consumers. Before consumers import it to a SOAP client, a system admin must enable it by setting <HideAdminServiceWSDLs>false</HideAdminServiceWSDLs> in <PRODUCT_HOME>/repository/conf/carbon.xml file and restarting the server.

  2. Create a SOAP Web service project in the soapUI using the above WSDL.

  3. Select listAllUsers operation under UserAdminSoap11Binding interface and click on the SOAP request. This invokes theĀ listAllUsers operation exposed through UserAdmin Web service.
  4. Click the Aut tab at the bottom of the request editor and give the admin credentials of your server in order to submit listAllUsers SOAP request using HTTP basic authentication headers.

  5. Enter the following values for the parameters of the SOAP request.

    Code Block
    <xsd:filter>*</xsd:filter>
    <xsd:limit>100</xsd:limit>
  6. You can now submit requests to the UserAdmin Web service and receive SOAP responses.