API/Services/UpdateServiceAuthentication

From Emersion
Jump to: navigation, search


Purpose: This is a method to update service identifiers marked as used for authentication.

WSDL: Services.wsdl

XSD: ServicesOperations.xsd

SAMPLE REQUEST

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">

  <soapenv:Header/>
  <soapenv:Body>
     <urn:UpdateServiceAuthentication>
        <urn:ServiceID>891139</urn:ServiceID>
        <urn:Username>auth_username</urn:Username>
        <urn:Realm>mycompany.com.au</urn:Realm>
        <urn:Password>auth_password</urn:Password>
        <urn:IgnorePasswordValidation>1</urn:IgnorePasswordValidation>
     </urn:UpdateServiceAuthentication>
  </soapenv:Body>

</soapenv:Envelope>

SAMPLE RESPONSE

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">

  <SOAP-ENV:Body>
     <ns1:UpdateServiceAuthenticationResponse/>
  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

INPUTS PERMITTED

  • Service ID - Mandatory
  • Username - Optional
  • Password - Optional
  • Ignore password validation - Optional
  • Service Identifier Realm - Optional

OUTPUT PROVIDED

  • Empty response for success
  • SOAPFault for validation issues or other errors

EXPECTED RESULTS

  • A new service identifier is created and the previous one is end-dated.

BUSINESS RULES

  • The IgnorePasswordValidation flag (if used) will bypass checking the auth password against the password policy used by the service type.

VALIDATION

  • Checks to ensure no duplicates.
  • Username is no longer than maximum field size.
  • Realm, if provided, is available for the given service type for the given provider.
  • Password meets complexity requirements where the force flag is not set.
  • Service has 1 (and only one) authentication based identifier.
  • Service is owned by a child of the caller
  • Service is active / pre-active