setPassword

ユーザーハンドルを指定するかどうかに応じて、特定のユーザーまたはデフォルトのユーザーのパスワードを特定の値に設定します。

パスワードの有効期限はオプションです。省略した場合、パスワードの有効期限は無期限になります。

認証済みユーザータイプ

メモ

** 他のユーザー IpsAdmin に対してsetPassword呼び出しを実行する権限があるのは、ユーザータイプのみです。

IpsAdmin
IpsCompanyAdmin
IpsUser
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalContrib
ImagePortalContribUser
ImagePortalUser

パラメータ

入力(setPasswordParam)

名前	種類	必須	説明
userHandle	xsd:string	いいえ	ユーザーハンドル。
パスワード	xsd:string	はい	パスワード. 選択したパスワードに対して、次の要件が適用されます。パスワードでは大文字と小文字が区別されます。パスワードの最小長は8文字です。パスワードには、次の文字クラスの1つ以上の文字を含める必要があります。小文字の英語文字。例： a b c d e など大文字の英語文字。例えば、 A B C D E などです。数値。例えば、 1 2 3 4 5 などです。特殊文字。例えば、次のいずれかを使用できます。 `～!@ # $ % ^ * ( ) _ + - = { } \| [ ] & \ :" ;' < > ?, . /
passwordExpires	xsd:dateTime	いいえ	パスワードの有効期限を決定します。注意：このフィールドのリクエストでタイムゾーンを指定します。タイムゾーンは中央時間に調整されます。

名前

種類

必須

説明

userHandle

xsd:string

いいえ

ユーザーハンドル。

パスワード

xsd:string

はい

パスワード.

選択したパスワードに対して、次の要件が適用されます。

パスワードでは大文字と小文字が区別されます。
パスワードの最小長は8文字です。
パスワードには、次の文字クラスの1つ以上の文字を含める必要があります。
- 小文字の英語文字。例： a b c d e など
- 大文字の英語文字。例えば、 A B C D E などです。
- 数値。例えば、 1 2 3 4 5 などです。
- 特殊文字。例えば、次のいずれかを使用できます。 `～!@ # $ % ^ * ( ) _ + - = { } | [ ] & \ :" ;' < > ?, . /

passwordExpires

xsd:dateTime

いいえ

パスワードの有効期限を決定します。

注意：このフィールドのリクエストでタイムゾーンを指定します。タイムゾーンは中央時間に調整されます。

出力(setPasswordReturn)

IPS APIは、この操作に対する応答を返しません。

例

このコードのサンプルでは、ユーザーパスワードを作成します。 passwordExpiresが省略されたので、パスワードの有効期限は切れません。

リクエスト

<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>

応答

なし