Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Service API Calls >

SetPassword


Allows the system administrator to set the passwords of users who use Oracle CRM On Demand.

Usage

You use the SetPassword method to enable external applications to synchronize user passwords. For security reasons the password API is not available by default. If customers want to use SetPassword, they can call Customer Care to have the functionality enabled. There are two privileges:

  • Change Company Passwords using Web Services. Enables access to SetPassword.
  • Manage Company Password Access. Users (usually administrators) who have been granted this privilege can grant other roles the Change Company Passwords using Web Services privilege.

The API allows for the setting of passwords for one or more users at the same time. For each password that is updated, a corresponding user Audit Trail record is created. A user with the ability to set passwords does not have the ability to update the password of another user who has the ability to set passwords.

Arguments

Table 59 describes the arguments taken by SetPassword. These are child elements of <ListofUser>.

Table 59. Arguments Taken by SetPassword
Field Name
Description
Required
Default
I/O

UserId

The row ID value of the user record.

Yes

Not applicable

Input/Output

EmailAddr

The user's email address

No

Not applicable

Input/Output

ExternalSystemId

The external system Id for the user.

No

Not applicable

Input/Output

IntegrationId

The integration Id

No

Not applicable

Input/Output

Password

The password for the user.

Yes

Not applicable

Input/Output

Allows the system administrator to set the passwords of users who use Oracle CRM On Demand.

Sample SOAP Request - SetPassword

The following SOAP request updates the password for the users in the request.

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <soap:Header>

      <wsse:Security>

         <wsse:UsernameToken>

            <wsse:Username>%%%USERNAME%%%</wsse:Username>

            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>

         </wsse:UsernameToken>

      </wsse:Security>

   </soap:Header>

   <soap:Body>

      <PasswordWS_SetPassword_Input xmlns="urn:crmondemand/ws/password/">

         <ListOfUser>

            <User>

               <UserId>HRZ780-KGY67</UserId>

               <EMailAddr />

               <Password>oracletest123</Password>

               <IntegrationId />

               <ExternalSystemId />

            </User>

         </ListOfUser>

      </PasswordWS_SetPassword_Input>

   </soap:Body>

</soap:Envelope>

Sample SOAP Response

The following response contains the status of the request:

<?xml version="1.0" encoding="utf-8"?>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   <SOAP-ENV:Body>

      <ns:PasswordWS_SetPassword_Output xmlns:ns="urn:crmondemand/ws/password/">

         <ns:Status>Success</ns:Status>

      </ns:PasswordWS_SetPassword_Output>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Oracle Web Services On Demand Guide, Version 21.0 (Oracle CRM On Demand Release 33) Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.