Sets the password of a specific user or the default user to a specific value, depending on whether you specify a user handle.
Password expiration date is optional. If omitted, the password never expires.
Only the IpsAdmin
user type is authorized to run setPassword calls against other users.
IpsAdmin
IpsCompanyAdmin
IpsUser
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
ImagePortalUser
Input (setPasswordParam)
Name |
Type |
Required |
Description |
---|---|---|---|
userHandle |
xsd:string |
No |
User handle. |
password |
xsd:string |
Yes |
Password. The following requirements are enforced on the chosen password:
|
passwordExpires |
xsd:dateTime |
No |
Determines password expiration date. Note: Provide the time zone with the request for this field. Time zones are adjusted to Central Time. |
Output (setPasswordReturn)
The IPS API does not return a response for this operation.
This code sample creates a user password. The password never expires because passwordExpires
was omitted.
Request
<ns1:setPasswordParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userHandle>3341|juser@scene7.com</ns1:userHandle>
<ns1:password>@Do6e$ySt3mz</ns1:password>
</ns1:setPasswordParam>
Response
None.