setPassword
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.
Authorized User types
IpsAdmin user type is authorized to run setPassword calls against other users.IpsAdminIpsCompanyAdminIpsUserTrialSiteAdminTrialSiteUserImagePortalAdminImagePortalContribImagePortalContribUserImagePortalUser
Parameters
Input (setPasswordParam)
Password.
The following requirements are enforced on the chosen password:
-
Passwords are case-sensitive.
-
The minimum password length is eight characters.
-
The password must contain one or more characters from the following character classes:
- Lowercase English characters. For example, a b c d e and so forth
- Uppercase English characters. For example, A B C D E and so forth.
- Numbers. For example, 1 2 3 4 5 and so forth.
- Special symbol characters. For example, you can use any of the following: ` ~ ! @ # $ % ^ * ( ) _ + - = { } | [ ] & \ : " ; ' < > ? , . /
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.
Examples
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.