getAuthenticationCredentials()

Credentials getAuthenticationCredentials(string usn)

This method retrieves a user password.

Note: The caller requires "view password" SOAP permission to run this method.

Note: Currently only password is supported, but this method is designed to be extensible and additional types may be added in the future.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription of which to retrieve authentication credentials.

Results

This method returns a Credentials XML document containing the subscription's password.

There are no messages defined by this method.

Example: A returned Credentials XML document

This example shows a Credentials XML document.

<Credentials xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <Credential>
    <Type>password</Type>
    <Parameters>
      <Object>
        <String name="password">UKRUqW5n7WR</String>
      </Object>
    </Parameters>
  </Credential>
</Credentials>

Faults

NoSuchItemException

This fault is returned when the account does not exist.

Access Exception

This fault is returned when attempting to access the password of a protected account.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetAuthenticationCredentials usn

usn: Purpose: Specifies the USN of the subscription.

Note: For more information about the Java client and the options it accepts, see Java client syntax.